-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
doc.go
84 lines (83 loc) · 4.11 KB
/
doc.go
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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package controltower provides the client and types for making API
// requests to AWS Control Tower.
//
// These interfaces allow you to apply the AWS library of pre-defined controls
// to your organizational units, programmatically. In this context, controls
// are the same as AWS Control Tower guardrails.
//
// To call these APIs, you'll need to know:
//
// - the ControlARN for the control--that is, the guardrail--you are targeting,
//
// - and the ARN associated with the target organizational unit (OU).
//
// To get the ControlARN for your AWS Control Tower guardrail:
//
// The ControlARN contains the control name which is specified in each guardrail.
// For a list of control names for Strongly recommended and Elective guardrails,
// see Resource identifiers for APIs and guardrails (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html)
// in the Automating tasks section (https://docs.aws.amazon.com/controltower/latest/userguide/automating-tasks.html)
// of the AWS Control Tower User Guide. Remember that Mandatory guardrails 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 ARN for an OU:
//
// In the AWS 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}
//
// Details and examples
//
// - List of resource identifiers for APIs and guardrails (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html)
//
// - Guardrail API examples (CLI) (https://docs.aws.amazon.com/controltower/latest/userguide/guardrail-api-examples-short.html)
//
// - Enable controls with AWS CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html)
//
// - Creating AWS Control Tower resources with AWS CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html)
//
// To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
// (https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-controltower)
//
// # Recording API Requests
//
// AWS Control Tower supports AWS CloudTrail, a service that records AWS API
// calls for your AWS account and delivers log files to an Amazon S3 bucket.
// By using information collected by CloudTrail, you can determine which requests
// the AWS Control Tower service received, who made the request and when, and
// so on. For more about AWS Control Tower and its support for CloudTrail, see
// Logging AWS Control Tower Actions with AWS CloudTrail (https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html)
// in the AWS Control Tower User Guide. To learn more about CloudTrail, including
// how to turn it on and find your log files, see the AWS CloudTrail User Guide.
//
// See https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10 for more information on this service.
//
// See controltower package documentation for more information.
// https://docs.aws.amazon.com/sdk-for-go/api/service/controltower/
//
// # Using the Client
//
// To contact AWS Control Tower with the SDK use the New function to create
// a new service client. With that client you can make API requests to the service.
// These clients are safe to use concurrently.
//
// See the SDK's documentation for more information on how to use the SDK.
// https://docs.aws.amazon.com/sdk-for-go/api/
//
// See aws.Config documentation for more information on configuring SDK clients.
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
//
// See the AWS Control Tower client ControlTower for more
// information on creating client for this service.
// https://docs.aws.amazon.com/sdk-for-go/api/service/controltower/#New
package controltower