File: doc.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (225 lines) | stat: -rw-r--r-- 12,284 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
// Code generated by smithy-go-codegen DO NOT EDIT.

// Package controltower provides the API client, operations, and parameter types
// for AWS Control Tower.
//
// Amazon Web Services Control Tower offers application programming interface
// (API) operations that support programmatic interaction with these types of
// resources:
//
// [Controls]
//
// [DisableControl]
//
// [EnableControl]
//
// [GetEnabledControl]
//
// [ListControlOperations]
//
// [ListEnabledControls]
//
// [UpdateEnabledControl]
//
// [Landing zones]
//
// [CreateLandingZone]
//
// [DeleteLandingZone]
//
// [GetLandingZone]
//
// [GetLandingZoneOperation]
//
// [ListLandingZones]
//
// [ResetLandingZone]
//
// [UpdateLandingZone]
//
// [Baselines]
//
// [DisableBaseline]
//
// [EnableBaseline]
//
// [GetBaseline]
//
// [GetBaselineOperation]
//
// [GetEnabledBaseline]
//
// [ListBaselines]
//
// [ListEnabledBaselines]
//
// [ResetEnabledBaseline]
//
// [UpdateEnabledBaseline]
//
// [Tagging]
//
// [ListTagsForResource]
//
// [TagResource]
//
// [UntagResource]
//
// For more information about these types of resources, see the [Amazon Web Services Control Tower User Guide].
//
// # About control APIs
//
// These interfaces allow you to apply the Amazon Web Services library of
// pre-defined controls to your organizational units, programmatically. In Amazon
// Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
//
// To call these APIs, you'll need to know:
//
//   - the controlIdentifier for the control--or guardrail--you are targeting.
//
//   - the ARN associated with the target organizational unit (OU), which we call
//     the targetIdentifier .
//
//   - the ARN associated with a resource that you wish to tag or untag.
//
// To get the controlIdentifier for your Amazon Web Services Control Tower
// control:
//
// The controlIdentifier is an ARN that is specified for each control. You can
// view the controlIdentifier in the console on the Control details page, as well
// as in the documentation.
//
// The controlIdentifier is unique in each Amazon Web Services Region for each
// control. You can find the controlIdentifier for each Region and control in the [Tables of control metadata]
// or the [Control availability by Region tables]in the Amazon Web Services Control Tower Controls Reference Guide.
//
// A quick-reference list of control identifers for the Amazon Web Services
// Control Tower legacy Strongly recommended and Elective controls is given in [Resource identifiers for APIs and controls]in
// the [Amazon Web Services Control Tower Controls Reference Guide]. Remember that Mandatory controls cannot be added or removed.
//
// ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
//
// Example:
//
//	arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
//
// To get the targetIdentifier :
//
// The targetIdentifier is the ARN for an OU.
//
// In the Amazon Web Services Organizations console, you can find the ARN for the
// OU on the Organizational unit details page associated with that OU.
//
// OU ARN format:
//
//	arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
//
// # About landing zone APIs
//
// You can configure and launch an Amazon Web Services Control Tower landing zone
// with APIs. For an introduction and steps, see [Getting started with Amazon Web Services Control Tower using APIs].
//
// For an overview of landing zone API operations, see [Amazon Web Services Control Tower supports landing zone APIs]. The individual API
// operations for landing zones are detailed in this document, the [API reference manual], in the
// "Actions" section.
//
// # About baseline APIs
//
// You can apply the AWSControlTowerBaseline baseline to an organizational unit
// (OU) as a way to register the OU with Amazon Web Services Control Tower,
// programmatically. For a general overview of this capability, see [Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines].
//
// You can call the baseline API operations to view the baselines that Amazon Web
// Services Control Tower enables for your landing zone, on your behalf, when
// setting up the landing zone. These baselines are read-only baselines.
//
// The individual API operations for baselines are detailed in this document, the [API reference manual]
// , in the "Actions" section. For usage examples, see [Baseline API input and output examples with CLI].
//
// # Details and examples
//
// [Control API input and output examples with CLI]
//
// [Baseline API input and output examples with CLI]
//
// [Enable controls with CloudFormation]
//
// [Launch a landing zone with CloudFormation]
//
// [Control metadata tables (large page)]
//
// [Control availability by Region tables (large page)]
//
// [List of identifiers for legacy controls]
//
// [Controls reference guide]
//
// [Controls library groupings]
//
// [Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation]
//
// To view the open source resource repository on GitHub, see [aws-cloudformation/aws-cloudformation-resource-providers-controltower]
//
// # Recording API Requests
//
// Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a
// service that records Amazon Web Services API calls for your Amazon Web Services
// account and delivers log files to an Amazon S3 bucket. By using information
// collected by CloudTrail, you can determine which requests the Amazon Web
// Services Control Tower service received, who made the request and when, and so
// on. For more about Amazon Web Services Control Tower and its support for
// CloudTrail, see [Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail]in the Amazon Web Services Control Tower User Guide. To learn
// more about CloudTrail, including how to turn it on and find your log files, see
// the Amazon Web Services CloudTrail User Guide.
//
// [Getting started with Amazon Web Services Control Tower using APIs]: https://docs.aws.amazon.com/controltower/latest/userguide/getting-started-apis.html
// [Launch a landing zone with CloudFormation]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html
// [GetLandingZone]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZone.html
// [DisableBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableBaseline.html
// [aws-cloudformation/aws-cloudformation-resource-providers-controltower]: https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower
// [ListBaselines]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListBaselines.html
// [ListEnabledBaselines]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledBaselines.html
// [ResetLandingZone]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html
// [Amazon Web Services Control Tower Controls Reference Guide]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html
// [GetLandingZoneOperation]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZoneOperation.html
// [GetBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaseline.html
// [Control API input and output examples with CLI]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html
// [DisableControl]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableControl.html
// [EnableControl]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html
// [Amazon Web Services Control Tower supports landing zone APIs]: https://docs.aws.amazon.com/controltower/latest/userguide/2023-all.html#landing-zone-apis
// [CreateLandingZone]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_CreateLandingZone.html
// [Control availability by Region tables]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html
// [Control metadata tables (large page)]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html
// [Controls library groupings]: https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html
// [ResetEnabledBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledBaseline.html
// [GetEnabledBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledBaseline.html
// [UntagResource]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_UntagResource.html
// [Amazon Web Services Control Tower User Guide]: https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html
// [Enable controls with CloudFormation]: https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html
// [EnableBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableBaseline.html
// [Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail]: https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html
// [UpdateEnabledControl]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html
// [ListTagsForResource]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListTagsForResource.html
// [UpdateLandingZone]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateLandingZone.html
// [Creating Amazon Web Services Control Tower resources with Amazon Web Services CloudFormation]: https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html
// [TagResource]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_TagResource.html
// [Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines]: https://docs.aws.amazon.com/controltower/latest/userguide/2024-all.html#baseline-apis
// [Resource identifiers for APIs and controls]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html
// [Baseline API input and output examples with CLI]: https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html
// [GetBaselineOperation]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaselineOperation.html
// [Controls reference guide]: https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html
// [Baselines]: https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html
// [ListEnabledControls]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledControls.html
// [GetEnabledControl]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledControl.html
// [List of identifiers for legacy controls]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html
// [Controls]: https://docs.aws.amazon.com/controltower/latest/userguide/controls.html
// [DeleteLandingZone]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_DeleteLandingZone.html
// [ListControlOperations]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListControlOperations.html
// [API reference manual]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_Operations.html
// [Tables of control metadata]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html
// [Control availability by Region tables (large page)]: https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html
// [Tagging]: https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html
// [Landing zones]: https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html
// [ListLandingZones]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZones.html
// [UpdateEnabledBaseline]: https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledBaseline.html
package controltower