Documentation ¶
Overview ¶
Package controltower provides the client and types for making API requests to AWS Control Tower.
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 (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html) in the Amazon Web Services Control Tower User 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 (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html) in the Controls reference guide section (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) of the Amazon Web Services Control Tower User 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}
Details and examples
Control API input and output examples with CLI (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html)
Enable controls with CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html)
Control metadata tables (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html)
List of identifiers for legacy controls (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html)
Controls reference guide (https://docs.aws.amazon.com/controltower/latest/userguide/controls.html)
Controls library groupings (https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.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)
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 ¶
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 (https://docs.aws.amazon.com/controltower/latest/userguide/logging-using-cloudtrail.html) 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.
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
Index ¶
- Constants
- func ControlOperationStatus_Values() []string
- func ControlOperationType_Values() []string
- func DriftStatus_Values() []string
- func EnablementStatus_Values() []string
- func LandingZoneOperationStatus_Values() []string
- func LandingZoneOperationType_Values() []string
- type AccessDeniedException
- func (s *AccessDeniedException) Code() string
- func (s *AccessDeniedException) Error() string
- func (s AccessDeniedException) GoString() string
- func (s *AccessDeniedException) Message() string
- func (s *AccessDeniedException) OrigErr() error
- func (s *AccessDeniedException) RequestID() string
- func (s *AccessDeniedException) StatusCode() int
- func (s AccessDeniedException) String() string
- type ConflictException
- func (s *ConflictException) Code() string
- func (s *ConflictException) Error() string
- func (s ConflictException) GoString() string
- func (s *ConflictException) Message() string
- func (s *ConflictException) OrigErr() error
- func (s *ConflictException) RequestID() string
- func (s *ConflictException) StatusCode() int
- func (s ConflictException) String() string
- type ControlOperation
- func (s ControlOperation) GoString() string
- func (s *ControlOperation) SetEndTime(v time.Time) *ControlOperation
- func (s *ControlOperation) SetOperationType(v string) *ControlOperation
- func (s *ControlOperation) SetStartTime(v time.Time) *ControlOperation
- func (s *ControlOperation) SetStatus(v string) *ControlOperation
- func (s *ControlOperation) SetStatusMessage(v string) *ControlOperation
- func (s ControlOperation) String() string
- type ControlTower
- func (c *ControlTower) DeleteLandingZone(input *DeleteLandingZoneInput) (*DeleteLandingZoneOutput, error)
- func (c *ControlTower) DeleteLandingZoneRequest(input *DeleteLandingZoneInput) (req *request.Request, output *DeleteLandingZoneOutput)
- func (c *ControlTower) DeleteLandingZoneWithContext(ctx aws.Context, input *DeleteLandingZoneInput, opts ...request.Option) (*DeleteLandingZoneOutput, error)
- func (c *ControlTower) DisableControl(input *DisableControlInput) (*DisableControlOutput, error)
- func (c *ControlTower) DisableControlRequest(input *DisableControlInput) (req *request.Request, output *DisableControlOutput)
- func (c *ControlTower) DisableControlWithContext(ctx aws.Context, input *DisableControlInput, opts ...request.Option) (*DisableControlOutput, error)
- func (c *ControlTower) EnableControl(input *EnableControlInput) (*EnableControlOutput, error)
- func (c *ControlTower) EnableControlRequest(input *EnableControlInput) (req *request.Request, output *EnableControlOutput)
- func (c *ControlTower) EnableControlWithContext(ctx aws.Context, input *EnableControlInput, opts ...request.Option) (*EnableControlOutput, error)
- func (c *ControlTower) GetControlOperation(input *GetControlOperationInput) (*GetControlOperationOutput, error)
- func (c *ControlTower) GetControlOperationRequest(input *GetControlOperationInput) (req *request.Request, output *GetControlOperationOutput)
- func (c *ControlTower) GetControlOperationWithContext(ctx aws.Context, input *GetControlOperationInput, opts ...request.Option) (*GetControlOperationOutput, error)
- func (c *ControlTower) GetEnabledControl(input *GetEnabledControlInput) (*GetEnabledControlOutput, error)
- func (c *ControlTower) GetEnabledControlRequest(input *GetEnabledControlInput) (req *request.Request, output *GetEnabledControlOutput)
- func (c *ControlTower) GetEnabledControlWithContext(ctx aws.Context, input *GetEnabledControlInput, opts ...request.Option) (*GetEnabledControlOutput, error)
- func (c *ControlTower) GetLandingZoneOperation(input *GetLandingZoneOperationInput) (*GetLandingZoneOperationOutput, error)
- func (c *ControlTower) GetLandingZoneOperationRequest(input *GetLandingZoneOperationInput) (req *request.Request, output *GetLandingZoneOperationOutput)
- func (c *ControlTower) GetLandingZoneOperationWithContext(ctx aws.Context, input *GetLandingZoneOperationInput, opts ...request.Option) (*GetLandingZoneOperationOutput, error)
- func (c *ControlTower) ListEnabledControls(input *ListEnabledControlsInput) (*ListEnabledControlsOutput, error)
- func (c *ControlTower) ListEnabledControlsPages(input *ListEnabledControlsInput, ...) error
- func (c *ControlTower) ListEnabledControlsPagesWithContext(ctx aws.Context, input *ListEnabledControlsInput, ...) error
- func (c *ControlTower) ListEnabledControlsRequest(input *ListEnabledControlsInput) (req *request.Request, output *ListEnabledControlsOutput)
- func (c *ControlTower) ListEnabledControlsWithContext(ctx aws.Context, input *ListEnabledControlsInput, opts ...request.Option) (*ListEnabledControlsOutput, error)
- func (c *ControlTower) ListLandingZones(input *ListLandingZonesInput) (*ListLandingZonesOutput, error)
- func (c *ControlTower) ListLandingZonesPages(input *ListLandingZonesInput, fn func(*ListLandingZonesOutput, bool) bool) error
- func (c *ControlTower) ListLandingZonesPagesWithContext(ctx aws.Context, input *ListLandingZonesInput, ...) error
- func (c *ControlTower) ListLandingZonesRequest(input *ListLandingZonesInput) (req *request.Request, output *ListLandingZonesOutput)
- func (c *ControlTower) ListLandingZonesWithContext(ctx aws.Context, input *ListLandingZonesInput, opts ...request.Option) (*ListLandingZonesOutput, error)
- func (c *ControlTower) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *ControlTower) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *ControlTower) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *ControlTower) ResetLandingZone(input *ResetLandingZoneInput) (*ResetLandingZoneOutput, error)
- func (c *ControlTower) ResetLandingZoneRequest(input *ResetLandingZoneInput) (req *request.Request, output *ResetLandingZoneOutput)
- func (c *ControlTower) ResetLandingZoneWithContext(ctx aws.Context, input *ResetLandingZoneInput, opts ...request.Option) (*ResetLandingZoneOutput, error)
- func (c *ControlTower) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *ControlTower) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *ControlTower) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *ControlTower) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *ControlTower) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *ControlTower) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- type DeleteLandingZoneInput
- type DeleteLandingZoneOutput
- type DisableControlInput
- func (s DisableControlInput) GoString() string
- func (s *DisableControlInput) SetControlIdentifier(v string) *DisableControlInput
- func (s *DisableControlInput) SetTargetIdentifier(v string) *DisableControlInput
- func (s DisableControlInput) String() string
- func (s *DisableControlInput) Validate() error
- type DisableControlOutput
- type DriftStatusSummary
- type EnableControlInput
- func (s EnableControlInput) GoString() string
- func (s *EnableControlInput) SetControlIdentifier(v string) *EnableControlInput
- func (s *EnableControlInput) SetTags(v map[string]*string) *EnableControlInput
- func (s *EnableControlInput) SetTargetIdentifier(v string) *EnableControlInput
- func (s EnableControlInput) String() string
- func (s *EnableControlInput) Validate() error
- type EnableControlOutput
- type EnabledControlDetails
- func (s EnabledControlDetails) GoString() string
- func (s *EnabledControlDetails) SetArn(v string) *EnabledControlDetails
- func (s *EnabledControlDetails) SetControlIdentifier(v string) *EnabledControlDetails
- func (s *EnabledControlDetails) SetDriftStatusSummary(v *DriftStatusSummary) *EnabledControlDetails
- func (s *EnabledControlDetails) SetStatusSummary(v *EnablementStatusSummary) *EnabledControlDetails
- func (s *EnabledControlDetails) SetTargetIdentifier(v string) *EnabledControlDetails
- func (s *EnabledControlDetails) SetTargetRegions(v []*Region) *EnabledControlDetails
- func (s EnabledControlDetails) String() string
- type EnabledControlSummary
- func (s EnabledControlSummary) GoString() string
- func (s *EnabledControlSummary) SetArn(v string) *EnabledControlSummary
- func (s *EnabledControlSummary) SetControlIdentifier(v string) *EnabledControlSummary
- func (s *EnabledControlSummary) SetDriftStatusSummary(v *DriftStatusSummary) *EnabledControlSummary
- func (s *EnabledControlSummary) SetStatusSummary(v *EnablementStatusSummary) *EnabledControlSummary
- func (s *EnabledControlSummary) SetTargetIdentifier(v string) *EnabledControlSummary
- func (s EnabledControlSummary) String() string
- type EnablementStatusSummary
- type GetControlOperationInput
- type GetControlOperationOutput
- type GetEnabledControlInput
- type GetEnabledControlOutput
- type GetLandingZoneOperationInput
- type GetLandingZoneOperationOutput
- type InternalServerException
- func (s *InternalServerException) Code() string
- func (s *InternalServerException) Error() string
- func (s InternalServerException) GoString() string
- func (s *InternalServerException) Message() string
- func (s *InternalServerException) OrigErr() error
- func (s *InternalServerException) RequestID() string
- func (s *InternalServerException) StatusCode() int
- func (s InternalServerException) String() string
- type LandingZoneOperationDetail
- func (s LandingZoneOperationDetail) GoString() string
- func (s *LandingZoneOperationDetail) SetEndTime(v time.Time) *LandingZoneOperationDetail
- func (s *LandingZoneOperationDetail) SetOperationType(v string) *LandingZoneOperationDetail
- func (s *LandingZoneOperationDetail) SetStartTime(v time.Time) *LandingZoneOperationDetail
- func (s *LandingZoneOperationDetail) SetStatus(v string) *LandingZoneOperationDetail
- func (s *LandingZoneOperationDetail) SetStatusMessage(v string) *LandingZoneOperationDetail
- func (s LandingZoneOperationDetail) String() string
- type LandingZoneSummary
- type ListEnabledControlsInput
- func (s ListEnabledControlsInput) GoString() string
- func (s *ListEnabledControlsInput) SetMaxResults(v int64) *ListEnabledControlsInput
- func (s *ListEnabledControlsInput) SetNextToken(v string) *ListEnabledControlsInput
- func (s *ListEnabledControlsInput) SetTargetIdentifier(v string) *ListEnabledControlsInput
- func (s ListEnabledControlsInput) String() string
- func (s *ListEnabledControlsInput) Validate() error
- type ListEnabledControlsOutput
- type ListLandingZonesInput
- func (s ListLandingZonesInput) GoString() string
- func (s *ListLandingZonesInput) SetMaxResults(v int64) *ListLandingZonesInput
- func (s *ListLandingZonesInput) SetNextToken(v string) *ListLandingZonesInput
- func (s ListLandingZonesInput) String() string
- func (s *ListLandingZonesInput) Validate() error
- type ListLandingZonesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Region
- type ResetLandingZoneInput
- type ResetLandingZoneOutput
- type ResourceNotFoundException
- func (s *ResourceNotFoundException) Code() string
- func (s *ResourceNotFoundException) Error() string
- func (s ResourceNotFoundException) GoString() string
- func (s *ResourceNotFoundException) Message() string
- func (s *ResourceNotFoundException) OrigErr() error
- func (s *ResourceNotFoundException) RequestID() string
- func (s *ResourceNotFoundException) StatusCode() int
- func (s ResourceNotFoundException) String() string
- type ServiceQuotaExceededException
- func (s *ServiceQuotaExceededException) Code() string
- func (s *ServiceQuotaExceededException) Error() string
- func (s ServiceQuotaExceededException) GoString() string
- func (s *ServiceQuotaExceededException) Message() string
- func (s *ServiceQuotaExceededException) OrigErr() error
- func (s *ServiceQuotaExceededException) RequestID() string
- func (s *ServiceQuotaExceededException) StatusCode() int
- func (s ServiceQuotaExceededException) String() string
- type TagResourceInput
- type TagResourceOutput
- type ThrottlingException
- func (s *ThrottlingException) Code() string
- func (s *ThrottlingException) Error() string
- func (s ThrottlingException) GoString() string
- func (s *ThrottlingException) Message() string
- func (s *ThrottlingException) OrigErr() error
- func (s *ThrottlingException) RequestID() string
- func (s *ThrottlingException) StatusCode() int
- func (s ThrottlingException) String() string
- type UntagResourceInput
- type UntagResourceOutput
- type ValidationException
- func (s *ValidationException) Code() string
- func (s *ValidationException) Error() string
- func (s ValidationException) GoString() string
- func (s *ValidationException) Message() string
- func (s *ValidationException) OrigErr() error
- func (s *ValidationException) RequestID() string
- func (s *ValidationException) StatusCode() int
- func (s ValidationException) String() string
Constants ¶
const ( // ControlOperationStatusSucceeded is a ControlOperationStatus enum value ControlOperationStatusSucceeded = "SUCCEEDED" // ControlOperationStatusFailed is a ControlOperationStatus enum value ControlOperationStatusFailed = "FAILED" // ControlOperationStatusInProgress is a ControlOperationStatus enum value ControlOperationStatusInProgress = "IN_PROGRESS" )
const ( // ControlOperationTypeEnableControl is a ControlOperationType enum value ControlOperationTypeEnableControl = "ENABLE_CONTROL" // ControlOperationTypeDisableControl is a ControlOperationType enum value ControlOperationTypeDisableControl = "DISABLE_CONTROL" // ControlOperationTypeUpdateEnabledControl is a ControlOperationType enum value ControlOperationTypeUpdateEnabledControl = "UPDATE_ENABLED_CONTROL" )
const ( // DriftStatusDrifted is a DriftStatus enum value DriftStatusDrifted = "DRIFTED" // DriftStatusInSync is a DriftStatus enum value DriftStatusInSync = "IN_SYNC" // DriftStatusNotChecking is a DriftStatus enum value DriftStatusNotChecking = "NOT_CHECKING" // DriftStatusUnknown is a DriftStatus enum value DriftStatusUnknown = "UNKNOWN" )
const ( // EnablementStatusSucceeded is a EnablementStatus enum value EnablementStatusSucceeded = "SUCCEEDED" // EnablementStatusFailed is a EnablementStatus enum value EnablementStatusFailed = "FAILED" // EnablementStatusUnderChange is a EnablementStatus enum value EnablementStatusUnderChange = "UNDER_CHANGE" )
const ( // LandingZoneOperationStatusSucceeded is a LandingZoneOperationStatus enum value LandingZoneOperationStatusSucceeded = "SUCCEEDED" // LandingZoneOperationStatusFailed is a LandingZoneOperationStatus enum value LandingZoneOperationStatusFailed = "FAILED" // LandingZoneOperationStatusInProgress is a LandingZoneOperationStatus enum value LandingZoneOperationStatusInProgress = "IN_PROGRESS" )
const ( // LandingZoneOperationTypeDelete is a LandingZoneOperationType enum value LandingZoneOperationTypeDelete = "DELETE" // LandingZoneOperationTypeCreate is a LandingZoneOperationType enum value LandingZoneOperationTypeCreate = "CREATE" // LandingZoneOperationTypeUpdate is a LandingZoneOperationType enum value LandingZoneOperationTypeUpdate = "UPDATE" // LandingZoneOperationTypeReset is a LandingZoneOperationType enum value LandingZoneOperationTypeReset = "RESET" )
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // // Updating or deleting the resource can cause an inconsistent state. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // // An unexpected error occurred during processing of a request. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // The request references a resource that does not exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // // The request would cause a service quota to be exceeded. The limit is 10 concurrent // operations. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // // The request was denied due to request throttling. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // // The input does not satisfy the constraints specified by an Amazon Web Services // service. ErrCodeValidationException = "ValidationException" )
const ( ServiceName = "ControlTower" // Name of service. EndpointsID = "controltower" // ID to lookup a service endpoint with. ServiceID = "ControlTower" // ServiceID is a unique identifier of a specific service. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
func ControlOperationStatus_Values ¶
func ControlOperationStatus_Values() []string
ControlOperationStatus_Values returns all elements of the ControlOperationStatus enum
func ControlOperationType_Values ¶
func ControlOperationType_Values() []string
ControlOperationType_Values returns all elements of the ControlOperationType enum
func DriftStatus_Values ¶ added in v1.45.25
func DriftStatus_Values() []string
DriftStatus_Values returns all elements of the DriftStatus enum
func EnablementStatus_Values ¶ added in v1.45.25
func EnablementStatus_Values() []string
EnablementStatus_Values returns all elements of the EnablementStatus enum
func LandingZoneOperationStatus_Values ¶ added in v1.48.4
func LandingZoneOperationStatus_Values() []string
LandingZoneOperationStatus_Values returns all elements of the LandingZoneOperationStatus enum
func LandingZoneOperationType_Values ¶ added in v1.48.4
func LandingZoneOperationType_Values() []string
LandingZoneOperationType_Values returns all elements of the LandingZoneOperationType enum
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
You do not have sufficient access to perform this action.
func (*AccessDeniedException) Code ¶
func (s *AccessDeniedException) Code() string
Code returns the exception type name.
func (*AccessDeniedException) Error ¶
func (s *AccessDeniedException) Error() string
func (AccessDeniedException) GoString ¶
func (s AccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*AccessDeniedException) Message ¶
func (s *AccessDeniedException) Message() string
Message returns the exception's message.
func (*AccessDeniedException) OrigErr ¶
func (s *AccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*AccessDeniedException) RequestID ¶
func (s *AccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*AccessDeniedException) StatusCode ¶
func (s *AccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (AccessDeniedException) String ¶
func (s AccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ConflictException ¶
type ConflictException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Updating or deleting the resource can cause an inconsistent state.
func (*ConflictException) Code ¶
func (s *ConflictException) Code() string
Code returns the exception type name.
func (*ConflictException) Error ¶
func (s *ConflictException) Error() string
func (ConflictException) GoString ¶
func (s ConflictException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ConflictException) Message ¶
func (s *ConflictException) Message() string
Message returns the exception's message.
func (*ConflictException) OrigErr ¶
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ConflictException) RequestID ¶
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ConflictException) StatusCode ¶
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ConflictException) String ¶
func (s ConflictException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ControlOperation ¶
type ControlOperation struct { // The time that the operation finished. EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` // One of ENABLE_CONTROL or DISABLE_CONTROL. OperationType *string `locationName:"operationType" type:"string" enum:"ControlOperationType"` // The time that the operation began. StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // One of IN_PROGRESS, SUCEEDED, or FAILED. Status *string `locationName:"status" type:"string" enum:"ControlOperationStatus"` // If the operation result is FAILED, this string contains a message explaining // why the operation failed. StatusMessage *string `locationName:"statusMessage" type:"string"` // contains filtered or unexported fields }
An operation performed by the control.
func (ControlOperation) GoString ¶
func (s ControlOperation) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ControlOperation) SetEndTime ¶
func (s *ControlOperation) SetEndTime(v time.Time) *ControlOperation
SetEndTime sets the EndTime field's value.
func (*ControlOperation) SetOperationType ¶
func (s *ControlOperation) SetOperationType(v string) *ControlOperation
SetOperationType sets the OperationType field's value.
func (*ControlOperation) SetStartTime ¶
func (s *ControlOperation) SetStartTime(v time.Time) *ControlOperation
SetStartTime sets the StartTime field's value.
func (*ControlOperation) SetStatus ¶
func (s *ControlOperation) SetStatus(v string) *ControlOperation
SetStatus sets the Status field's value.
func (*ControlOperation) SetStatusMessage ¶
func (s *ControlOperation) SetStatusMessage(v string) *ControlOperation
SetStatusMessage sets the StatusMessage field's value.
func (ControlOperation) String ¶
func (s ControlOperation) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ControlTower ¶
ControlTower provides the API operation methods for making requests to AWS Control Tower. See this package's package overview docs for details on the service.
ControlTower methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *ControlTower
New creates a new instance of the ControlTower client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a ControlTower client from just a session. svc := controltower.New(mySession) // Create a ControlTower client with additional configuration svc := controltower.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*ControlTower) DeleteLandingZone ¶ added in v1.48.4
func (c *ControlTower) DeleteLandingZone(input *DeleteLandingZoneInput) (*DeleteLandingZoneOutput, error)
DeleteLandingZone API operation for AWS Control Tower.
Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation DeleteLandingZone for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
ConflictException Updating or deleting the resource can cause an inconsistent state.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZone
func (*ControlTower) DeleteLandingZoneRequest ¶ added in v1.48.4
func (c *ControlTower) DeleteLandingZoneRequest(input *DeleteLandingZoneInput) (req *request.Request, output *DeleteLandingZoneOutput)
DeleteLandingZoneRequest generates a "aws/request.Request" representing the client's request for the DeleteLandingZone operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteLandingZone for more information on using the DeleteLandingZone API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteLandingZoneRequest method. req, resp := client.DeleteLandingZoneRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DeleteLandingZone
func (*ControlTower) DeleteLandingZoneWithContext ¶ added in v1.48.4
func (c *ControlTower) DeleteLandingZoneWithContext(ctx aws.Context, input *DeleteLandingZoneInput, opts ...request.Option) (*DeleteLandingZoneOutput, error)
DeleteLandingZoneWithContext is the same as DeleteLandingZone with the addition of the ability to pass a context and additional request options.
See DeleteLandingZone for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) DisableControl ¶
func (c *ControlTower) DisableControl(input *DisableControlInput) (*DisableControlOutput, error)
DisableControl API operation for AWS Control Tower.
This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation DisableControl for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
ConflictException Updating or deleting the resource can cause an inconsistent state.
ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControl
func (*ControlTower) DisableControlRequest ¶
func (c *ControlTower) DisableControlRequest(input *DisableControlInput) (req *request.Request, output *DisableControlOutput)
DisableControlRequest generates a "aws/request.Request" representing the client's request for the DisableControl operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DisableControl for more information on using the DisableControl API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DisableControlRequest method. req, resp := client.DisableControlRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/DisableControl
func (*ControlTower) DisableControlWithContext ¶
func (c *ControlTower) DisableControlWithContext(ctx aws.Context, input *DisableControlInput, opts ...request.Option) (*DisableControlOutput, error)
DisableControlWithContext is the same as DisableControl with the addition of the ability to pass a context and additional request options.
See DisableControl for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) EnableControl ¶
func (c *ControlTower) EnableControl(input *EnableControlInput) (*EnableControlOutput, error)
EnableControl API operation for AWS Control Tower.
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation EnableControl for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
ConflictException Updating or deleting the resource can cause an inconsistent state.
ServiceQuotaExceededException The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControl
func (*ControlTower) EnableControlRequest ¶
func (c *ControlTower) EnableControlRequest(input *EnableControlInput) (req *request.Request, output *EnableControlOutput)
EnableControlRequest generates a "aws/request.Request" representing the client's request for the EnableControl operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See EnableControl for more information on using the EnableControl API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the EnableControlRequest method. req, resp := client.EnableControlRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/EnableControl
func (*ControlTower) EnableControlWithContext ¶
func (c *ControlTower) EnableControlWithContext(ctx aws.Context, input *EnableControlInput, opts ...request.Option) (*EnableControlOutput, error)
EnableControlWithContext is the same as EnableControl with the addition of the ability to pass a context and additional request options.
See EnableControl for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) GetControlOperation ¶
func (c *ControlTower) GetControlOperation(input *GetControlOperationInput) (*GetControlOperationOutput, error)
GetControlOperation API operation for AWS Control Tower.
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation GetControlOperation for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperation
func (*ControlTower) GetControlOperationRequest ¶
func (c *ControlTower) GetControlOperationRequest(input *GetControlOperationInput) (req *request.Request, output *GetControlOperationOutput)
GetControlOperationRequest generates a "aws/request.Request" representing the client's request for the GetControlOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetControlOperation for more information on using the GetControlOperation API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetControlOperationRequest method. req, resp := client.GetControlOperationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetControlOperation
func (*ControlTower) GetControlOperationWithContext ¶
func (c *ControlTower) GetControlOperationWithContext(ctx aws.Context, input *GetControlOperationInput, opts ...request.Option) (*GetControlOperationOutput, error)
GetControlOperationWithContext is the same as GetControlOperation with the addition of the ability to pass a context and additional request options.
See GetControlOperation for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) GetEnabledControl ¶ added in v1.45.25
func (c *ControlTower) GetEnabledControl(input *GetEnabledControlInput) (*GetEnabledControlOutput, error)
GetEnabledControl API operation for AWS Control Tower.
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation GetEnabledControl for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetEnabledControl
func (*ControlTower) GetEnabledControlRequest ¶ added in v1.45.25
func (c *ControlTower) GetEnabledControlRequest(input *GetEnabledControlInput) (req *request.Request, output *GetEnabledControlOutput)
GetEnabledControlRequest generates a "aws/request.Request" representing the client's request for the GetEnabledControl operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetEnabledControl for more information on using the GetEnabledControl API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetEnabledControlRequest method. req, resp := client.GetEnabledControlRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetEnabledControl
func (*ControlTower) GetEnabledControlWithContext ¶ added in v1.45.25
func (c *ControlTower) GetEnabledControlWithContext(ctx aws.Context, input *GetEnabledControlInput, opts ...request.Option) (*GetEnabledControlOutput, error)
GetEnabledControlWithContext is the same as GetEnabledControl with the addition of the ability to pass a context and additional request options.
See GetEnabledControl for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) GetLandingZoneOperation ¶ added in v1.48.4
func (c *ControlTower) GetLandingZoneOperation(input *GetLandingZoneOperationInput) (*GetLandingZoneOperationOutput, error)
GetLandingZoneOperation API operation for AWS Control Tower.
Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation GetLandingZoneOperation for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperation
func (*ControlTower) GetLandingZoneOperationRequest ¶ added in v1.48.4
func (c *ControlTower) GetLandingZoneOperationRequest(input *GetLandingZoneOperationInput) (req *request.Request, output *GetLandingZoneOperationOutput)
GetLandingZoneOperationRequest generates a "aws/request.Request" representing the client's request for the GetLandingZoneOperation operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetLandingZoneOperation for more information on using the GetLandingZoneOperation API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetLandingZoneOperationRequest method. req, resp := client.GetLandingZoneOperationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/GetLandingZoneOperation
func (*ControlTower) GetLandingZoneOperationWithContext ¶ added in v1.48.4
func (c *ControlTower) GetLandingZoneOperationWithContext(ctx aws.Context, input *GetLandingZoneOperationInput, opts ...request.Option) (*GetLandingZoneOperationOutput, error)
GetLandingZoneOperationWithContext is the same as GetLandingZoneOperation with the addition of the ability to pass a context and additional request options.
See GetLandingZoneOperation for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ListEnabledControls ¶
func (c *ControlTower) ListEnabledControls(input *ListEnabledControlsInput) (*ListEnabledControlsOutput, error)
ListEnabledControls API operation for AWS Control Tower.
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation ListEnabledControls for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControls
func (*ControlTower) ListEnabledControlsPages ¶
func (c *ControlTower) ListEnabledControlsPages(input *ListEnabledControlsInput, fn func(*ListEnabledControlsOutput, bool) bool) error
ListEnabledControlsPages iterates over the pages of a ListEnabledControls operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListEnabledControls method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListEnabledControls operation. pageNum := 0 err := client.ListEnabledControlsPages(params, func(page *controltower.ListEnabledControlsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*ControlTower) ListEnabledControlsPagesWithContext ¶
func (c *ControlTower) ListEnabledControlsPagesWithContext(ctx aws.Context, input *ListEnabledControlsInput, fn func(*ListEnabledControlsOutput, bool) bool, opts ...request.Option) error
ListEnabledControlsPagesWithContext same as ListEnabledControlsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ListEnabledControlsRequest ¶
func (c *ControlTower) ListEnabledControlsRequest(input *ListEnabledControlsInput) (req *request.Request, output *ListEnabledControlsOutput)
ListEnabledControlsRequest generates a "aws/request.Request" representing the client's request for the ListEnabledControls operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListEnabledControls for more information on using the ListEnabledControls API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListEnabledControlsRequest method. req, resp := client.ListEnabledControlsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListEnabledControls
func (*ControlTower) ListEnabledControlsWithContext ¶
func (c *ControlTower) ListEnabledControlsWithContext(ctx aws.Context, input *ListEnabledControlsInput, opts ...request.Option) (*ListEnabledControlsOutput, error)
ListEnabledControlsWithContext is the same as ListEnabledControls with the addition of the ability to pass a context and additional request options.
See ListEnabledControls for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ListLandingZones ¶ added in v1.48.4
func (c *ControlTower) ListLandingZones(input *ListLandingZonesInput) (*ListLandingZonesOutput, error)
ListLandingZones API operation for AWS Control Tower.
Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation ListLandingZones for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZones
func (*ControlTower) ListLandingZonesPages ¶ added in v1.48.4
func (c *ControlTower) ListLandingZonesPages(input *ListLandingZonesInput, fn func(*ListLandingZonesOutput, bool) bool) error
ListLandingZonesPages iterates over the pages of a ListLandingZones operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListLandingZones method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListLandingZones operation. pageNum := 0 err := client.ListLandingZonesPages(params, func(page *controltower.ListLandingZonesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*ControlTower) ListLandingZonesPagesWithContext ¶ added in v1.48.4
func (c *ControlTower) ListLandingZonesPagesWithContext(ctx aws.Context, input *ListLandingZonesInput, fn func(*ListLandingZonesOutput, bool) bool, opts ...request.Option) error
ListLandingZonesPagesWithContext same as ListLandingZonesPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ListLandingZonesRequest ¶ added in v1.48.4
func (c *ControlTower) ListLandingZonesRequest(input *ListLandingZonesInput) (req *request.Request, output *ListLandingZonesOutput)
ListLandingZonesRequest generates a "aws/request.Request" representing the client's request for the ListLandingZones operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListLandingZones for more information on using the ListLandingZones API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListLandingZonesRequest method. req, resp := client.ListLandingZonesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZones
func (*ControlTower) ListLandingZonesWithContext ¶ added in v1.48.4
func (c *ControlTower) ListLandingZonesWithContext(ctx aws.Context, input *ListLandingZonesInput, opts ...request.Option) (*ListLandingZonesOutput, error)
ListLandingZonesWithContext is the same as ListLandingZones with the addition of the ability to pass a context and additional request options.
See ListLandingZones for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ListTagsForResource ¶ added in v1.47.9
func (c *ControlTower) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for AWS Control Tower.
Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation ListTagsForResource for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListTagsForResource
func (*ControlTower) ListTagsForResourceRequest ¶ added in v1.47.9
func (c *ControlTower) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListTagsForResource
func (*ControlTower) ListTagsForResourceWithContext ¶ added in v1.47.9
func (c *ControlTower) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) ResetLandingZone ¶ added in v1.48.4
func (c *ControlTower) ResetLandingZone(input *ResetLandingZoneInput) (*ResetLandingZoneOutput, error)
ResetLandingZone API operation for AWS Control Tower.
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation ResetLandingZone for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
ConflictException Updating or deleting the resource can cause an inconsistent state.
InternalServerException An unexpected error occurred during processing of a request.
AccessDeniedException You do not have sufficient access to perform this action.
ThrottlingException The request was denied due to request throttling.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZone
func (*ControlTower) ResetLandingZoneRequest ¶ added in v1.48.4
func (c *ControlTower) ResetLandingZoneRequest(input *ResetLandingZoneInput) (req *request.Request, output *ResetLandingZoneOutput)
ResetLandingZoneRequest generates a "aws/request.Request" representing the client's request for the ResetLandingZone operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ResetLandingZone for more information on using the ResetLandingZone API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ResetLandingZoneRequest method. req, resp := client.ResetLandingZoneRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ResetLandingZone
func (*ControlTower) ResetLandingZoneWithContext ¶ added in v1.48.4
func (c *ControlTower) ResetLandingZoneWithContext(ctx aws.Context, input *ResetLandingZoneInput, opts ...request.Option) (*ResetLandingZoneOutput, error)
ResetLandingZoneWithContext is the same as ResetLandingZone with the addition of the ability to pass a context and additional request options.
See ResetLandingZone for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) TagResource ¶ added in v1.47.9
func (c *ControlTower) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS Control Tower.
Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation TagResource for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/TagResource
func (*ControlTower) TagResourceRequest ¶ added in v1.47.9
func (c *ControlTower) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/TagResource
func (*ControlTower) TagResourceWithContext ¶ added in v1.47.9
func (c *ControlTower) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ControlTower) UntagResource ¶ added in v1.47.9
func (c *ControlTower) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS Control Tower.
Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS Control Tower's API operation UntagResource for usage and error information.
Returned Error Types:
ValidationException The input does not satisfy the constraints specified by an Amazon Web Services service.
InternalServerException An unexpected error occurred during processing of a request.
ResourceNotFoundException The request references a resource that does not exist.
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UntagResource
func (*ControlTower) UntagResourceRequest ¶ added in v1.47.9
func (c *ControlTower) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/UntagResource
func (*ControlTower) UntagResourceWithContext ¶ added in v1.47.9
func (c *ControlTower) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type DeleteLandingZoneInput ¶ added in v1.48.4
type DeleteLandingZoneInput struct { // The unique identifier of the landing zone. // // LandingZoneIdentifier is a required field LandingZoneIdentifier *string `locationName:"landingZoneIdentifier" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteLandingZoneInput) GoString ¶ added in v1.48.4
func (s DeleteLandingZoneInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteLandingZoneInput) SetLandingZoneIdentifier ¶ added in v1.48.4
func (s *DeleteLandingZoneInput) SetLandingZoneIdentifier(v string) *DeleteLandingZoneInput
SetLandingZoneIdentifier sets the LandingZoneIdentifier field's value.
func (DeleteLandingZoneInput) String ¶ added in v1.48.4
func (s DeleteLandingZoneInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteLandingZoneInput) Validate ¶ added in v1.48.4
func (s *DeleteLandingZoneInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLandingZoneOutput ¶ added in v1.48.4
type DeleteLandingZoneOutput struct { // >A unique identifier assigned to a DeleteLandingZone operation. You can use // this identifier as an input parameter of GetLandingZoneOperation to check // the operation's status. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteLandingZoneOutput) GoString ¶ added in v1.48.4
func (s DeleteLandingZoneOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DeleteLandingZoneOutput) SetOperationIdentifier ¶ added in v1.48.4
func (s *DeleteLandingZoneOutput) SetOperationIdentifier(v string) *DeleteLandingZoneOutput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (DeleteLandingZoneOutput) String ¶ added in v1.48.4
func (s DeleteLandingZoneOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DisableControlInput ¶
type DisableControlInput struct { // The ARN of the control. Only Strongly recommended and Elective controls are // permitted, with the exception of the landing zone Region deny control. For // information on how to find the controlIdentifier, see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). // // ControlIdentifier is a required field ControlIdentifier *string `locationName:"controlIdentifier" min:"20" type:"string" required:"true"` // The ARN of the organizational unit. For information on how to find the targetIdentifier, // see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). // // TargetIdentifier is a required field TargetIdentifier *string `locationName:"targetIdentifier" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (DisableControlInput) GoString ¶
func (s DisableControlInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DisableControlInput) SetControlIdentifier ¶
func (s *DisableControlInput) SetControlIdentifier(v string) *DisableControlInput
SetControlIdentifier sets the ControlIdentifier field's value.
func (*DisableControlInput) SetTargetIdentifier ¶
func (s *DisableControlInput) SetTargetIdentifier(v string) *DisableControlInput
SetTargetIdentifier sets the TargetIdentifier field's value.
func (DisableControlInput) String ¶
func (s DisableControlInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DisableControlInput) Validate ¶
func (s *DisableControlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisableControlOutput ¶
type DisableControlOutput struct { // The ID of the asynchronous operation, which is used to track status. The // operation is available for 90 days. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (DisableControlOutput) GoString ¶
func (s DisableControlOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DisableControlOutput) SetOperationIdentifier ¶
func (s *DisableControlOutput) SetOperationIdentifier(v string) *DisableControlOutput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (DisableControlOutput) String ¶
func (s DisableControlOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DriftStatusSummary ¶ added in v1.45.25
type DriftStatusSummary struct { // The drift status of the enabled control. // // Valid values: // // * DRIFTED: The enabledControl deployed in this configuration doesn’t // match the configuration that Amazon Web Services Control Tower expected. // // * IN_SYNC: The enabledControl deployed in this configuration matches the // configuration that Amazon Web Services Control Tower expected. // // * NOT_CHECKING: Amazon Web Services Control Tower does not check drift // for this enabled control. Drift is not supported for the control type. // // * UNKNOWN: Amazon Web Services Control Tower is not able to check the // drift status for the enabled control. DriftStatus *string `locationName:"driftStatus" type:"string" enum:"DriftStatus"` // contains filtered or unexported fields }
The drift summary of the enabled control.
Amazon Web Services Control Tower expects the enabled control configuration to include all supported and governed Regions. If the enabled control differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the enabled control.
func (DriftStatusSummary) GoString ¶ added in v1.45.25
func (s DriftStatusSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*DriftStatusSummary) SetDriftStatus ¶ added in v1.45.25
func (s *DriftStatusSummary) SetDriftStatus(v string) *DriftStatusSummary
SetDriftStatus sets the DriftStatus field's value.
func (DriftStatusSummary) String ¶ added in v1.45.25
func (s DriftStatusSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnableControlInput ¶
type EnableControlInput struct { // The ARN of the control. Only Strongly recommended and Elective controls are // permitted, with the exception of the landing zone Region deny control. For // information on how to find the controlIdentifier, see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). // // ControlIdentifier is a required field ControlIdentifier *string `locationName:"controlIdentifier" min:"20" type:"string" required:"true"` // Tags to be applied to the EnabledControl resource. Tags map[string]*string `locationName:"tags" type:"map"` // The ARN of the organizational unit. For information on how to find the targetIdentifier, // see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). // // TargetIdentifier is a required field TargetIdentifier *string `locationName:"targetIdentifier" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (EnableControlInput) GoString ¶
func (s EnableControlInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnableControlInput) SetControlIdentifier ¶
func (s *EnableControlInput) SetControlIdentifier(v string) *EnableControlInput
SetControlIdentifier sets the ControlIdentifier field's value.
func (*EnableControlInput) SetTags ¶ added in v1.47.9
func (s *EnableControlInput) SetTags(v map[string]*string) *EnableControlInput
SetTags sets the Tags field's value.
func (*EnableControlInput) SetTargetIdentifier ¶
func (s *EnableControlInput) SetTargetIdentifier(v string) *EnableControlInput
SetTargetIdentifier sets the TargetIdentifier field's value.
func (EnableControlInput) String ¶
func (s EnableControlInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnableControlInput) Validate ¶
func (s *EnableControlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type EnableControlOutput ¶
type EnableControlOutput struct { // The ARN of the EnabledControl resource. Arn *string `locationName:"arn" min:"20" type:"string"` // The ID of the asynchronous operation, which is used to track status. The // operation is available for 90 days. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (EnableControlOutput) GoString ¶
func (s EnableControlOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnableControlOutput) SetArn ¶ added in v1.47.9
func (s *EnableControlOutput) SetArn(v string) *EnableControlOutput
SetArn sets the Arn field's value.
func (*EnableControlOutput) SetOperationIdentifier ¶
func (s *EnableControlOutput) SetOperationIdentifier(v string) *EnableControlOutput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (EnableControlOutput) String ¶
func (s EnableControlOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnabledControlDetails ¶ added in v1.45.25
type EnabledControlDetails struct { // The ARN of the enabled control. Arn *string `locationName:"arn" min:"20" type:"string"` // The control identifier of the enabled control. For information on how to // find the controlIdentifier, see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). ControlIdentifier *string `locationName:"controlIdentifier" min:"20" type:"string"` // The drift status of the enabled control. DriftStatusSummary *DriftStatusSummary `locationName:"driftStatusSummary" type:"structure"` // The deployment summary of the enabled control. StatusSummary *EnablementStatusSummary `locationName:"statusSummary" type:"structure"` // The ARN of the organizational unit. For information on how to find the targetIdentifier, // see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). TargetIdentifier *string `locationName:"targetIdentifier" min:"20" type:"string"` // Target Amazon Web Services Regions for the enabled control. TargetRegions []*Region `locationName:"targetRegions" type:"list"` // contains filtered or unexported fields }
Information about the enabled control.
func (EnabledControlDetails) GoString ¶ added in v1.45.25
func (s EnabledControlDetails) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnabledControlDetails) SetArn ¶ added in v1.45.25
func (s *EnabledControlDetails) SetArn(v string) *EnabledControlDetails
SetArn sets the Arn field's value.
func (*EnabledControlDetails) SetControlIdentifier ¶ added in v1.45.25
func (s *EnabledControlDetails) SetControlIdentifier(v string) *EnabledControlDetails
SetControlIdentifier sets the ControlIdentifier field's value.
func (*EnabledControlDetails) SetDriftStatusSummary ¶ added in v1.45.25
func (s *EnabledControlDetails) SetDriftStatusSummary(v *DriftStatusSummary) *EnabledControlDetails
SetDriftStatusSummary sets the DriftStatusSummary field's value.
func (*EnabledControlDetails) SetStatusSummary ¶ added in v1.45.25
func (s *EnabledControlDetails) SetStatusSummary(v *EnablementStatusSummary) *EnabledControlDetails
SetStatusSummary sets the StatusSummary field's value.
func (*EnabledControlDetails) SetTargetIdentifier ¶ added in v1.45.25
func (s *EnabledControlDetails) SetTargetIdentifier(v string) *EnabledControlDetails
SetTargetIdentifier sets the TargetIdentifier field's value.
func (*EnabledControlDetails) SetTargetRegions ¶ added in v1.45.25
func (s *EnabledControlDetails) SetTargetRegions(v []*Region) *EnabledControlDetails
SetTargetRegions sets the TargetRegions field's value.
func (EnabledControlDetails) String ¶ added in v1.45.25
func (s EnabledControlDetails) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnabledControlSummary ¶
type EnabledControlSummary struct { // The ARN of the enabled control. Arn *string `locationName:"arn" min:"20" type:"string"` // The controlIdentifier of the enabled control. ControlIdentifier *string `locationName:"controlIdentifier" min:"20" type:"string"` // The drift status of the enabled control. DriftStatusSummary *DriftStatusSummary `locationName:"driftStatusSummary" type:"structure"` // A short description of the status of the enabled control. StatusSummary *EnablementStatusSummary `locationName:"statusSummary" type:"structure"` // The ARN of the organizational unit. TargetIdentifier *string `locationName:"targetIdentifier" min:"20" type:"string"` // contains filtered or unexported fields }
Returns a summary of information about an enabled control.
func (EnabledControlSummary) GoString ¶
func (s EnabledControlSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnabledControlSummary) SetArn ¶ added in v1.45.25
func (s *EnabledControlSummary) SetArn(v string) *EnabledControlSummary
SetArn sets the Arn field's value.
func (*EnabledControlSummary) SetControlIdentifier ¶
func (s *EnabledControlSummary) SetControlIdentifier(v string) *EnabledControlSummary
SetControlIdentifier sets the ControlIdentifier field's value.
func (*EnabledControlSummary) SetDriftStatusSummary ¶ added in v1.45.25
func (s *EnabledControlSummary) SetDriftStatusSummary(v *DriftStatusSummary) *EnabledControlSummary
SetDriftStatusSummary sets the DriftStatusSummary field's value.
func (*EnabledControlSummary) SetStatusSummary ¶ added in v1.45.25
func (s *EnabledControlSummary) SetStatusSummary(v *EnablementStatusSummary) *EnabledControlSummary
SetStatusSummary sets the StatusSummary field's value.
func (*EnabledControlSummary) SetTargetIdentifier ¶ added in v1.45.25
func (s *EnabledControlSummary) SetTargetIdentifier(v string) *EnabledControlSummary
SetTargetIdentifier sets the TargetIdentifier field's value.
func (EnabledControlSummary) String ¶
func (s EnabledControlSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type EnablementStatusSummary ¶ added in v1.45.25
type EnablementStatusSummary struct { // The last operation identifier for the enabled control. LastOperationIdentifier *string `locationName:"lastOperationIdentifier" min:"36" type:"string"` // The deployment status of the enabled control. // // Valid values: // // * SUCCEEDED: The enabledControl configuration was deployed successfully. // // * UNDER_CHANGE: The enabledControl configuration is changing. // // * FAILED: The enabledControl configuration failed to deploy. Status *string `locationName:"status" type:"string" enum:"EnablementStatus"` // contains filtered or unexported fields }
The deployment summary of the enabled control.
func (EnablementStatusSummary) GoString ¶ added in v1.45.25
func (s EnablementStatusSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*EnablementStatusSummary) SetLastOperationIdentifier ¶ added in v1.45.25
func (s *EnablementStatusSummary) SetLastOperationIdentifier(v string) *EnablementStatusSummary
SetLastOperationIdentifier sets the LastOperationIdentifier field's value.
func (*EnablementStatusSummary) SetStatus ¶ added in v1.45.25
func (s *EnablementStatusSummary) SetStatus(v string) *EnablementStatusSummary
SetStatus sets the Status field's value.
func (EnablementStatusSummary) String ¶ added in v1.45.25
func (s EnablementStatusSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetControlOperationInput ¶
type GetControlOperationInput struct { // The ID of the asynchronous operation, which is used to track status. The // operation is available for 90 days. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetControlOperationInput) GoString ¶
func (s GetControlOperationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetControlOperationInput) SetOperationIdentifier ¶
func (s *GetControlOperationInput) SetOperationIdentifier(v string) *GetControlOperationInput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (GetControlOperationInput) String ¶
func (s GetControlOperationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetControlOperationInput) Validate ¶
func (s *GetControlOperationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetControlOperationOutput ¶
type GetControlOperationOutput struct { // An operation performed by the control. // // ControlOperation is a required field ControlOperation *ControlOperation `locationName:"controlOperation" type:"structure" required:"true"` // contains filtered or unexported fields }
func (GetControlOperationOutput) GoString ¶
func (s GetControlOperationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetControlOperationOutput) SetControlOperation ¶
func (s *GetControlOperationOutput) SetControlOperation(v *ControlOperation) *GetControlOperationOutput
SetControlOperation sets the ControlOperation field's value.
func (GetControlOperationOutput) String ¶
func (s GetControlOperationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetEnabledControlInput ¶ added in v1.45.25
type GetEnabledControlInput struct { // The controlIdentifier of the enabled control. // // EnabledControlIdentifier is a required field EnabledControlIdentifier *string `locationName:"enabledControlIdentifier" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetEnabledControlInput) GoString ¶ added in v1.45.25
func (s GetEnabledControlInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetEnabledControlInput) SetEnabledControlIdentifier ¶ added in v1.45.25
func (s *GetEnabledControlInput) SetEnabledControlIdentifier(v string) *GetEnabledControlInput
SetEnabledControlIdentifier sets the EnabledControlIdentifier field's value.
func (GetEnabledControlInput) String ¶ added in v1.45.25
func (s GetEnabledControlInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetEnabledControlInput) Validate ¶ added in v1.45.25
func (s *GetEnabledControlInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEnabledControlOutput ¶ added in v1.45.25
type GetEnabledControlOutput struct { // Information about the enabled control. // // EnabledControlDetails is a required field EnabledControlDetails *EnabledControlDetails `locationName:"enabledControlDetails" type:"structure" required:"true"` // contains filtered or unexported fields }
func (GetEnabledControlOutput) GoString ¶ added in v1.45.25
func (s GetEnabledControlOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetEnabledControlOutput) SetEnabledControlDetails ¶ added in v1.45.25
func (s *GetEnabledControlOutput) SetEnabledControlDetails(v *EnabledControlDetails) *GetEnabledControlOutput
SetEnabledControlDetails sets the EnabledControlDetails field's value.
func (GetEnabledControlOutput) String ¶ added in v1.45.25
func (s GetEnabledControlOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetLandingZoneOperationInput ¶ added in v1.48.4
type GetLandingZoneOperationInput struct { // A unique identifier assigned to a landing zone operation. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (GetLandingZoneOperationInput) GoString ¶ added in v1.48.4
func (s GetLandingZoneOperationInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetLandingZoneOperationInput) SetOperationIdentifier ¶ added in v1.48.4
func (s *GetLandingZoneOperationInput) SetOperationIdentifier(v string) *GetLandingZoneOperationInput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (GetLandingZoneOperationInput) String ¶ added in v1.48.4
func (s GetLandingZoneOperationInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetLandingZoneOperationInput) Validate ¶ added in v1.48.4
func (s *GetLandingZoneOperationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetLandingZoneOperationOutput ¶ added in v1.48.4
type GetLandingZoneOperationOutput struct { // Details about a landing zone operation. // // OperationDetails is a required field OperationDetails *LandingZoneOperationDetail `locationName:"operationDetails" type:"structure" required:"true"` // contains filtered or unexported fields }
func (GetLandingZoneOperationOutput) GoString ¶ added in v1.48.4
func (s GetLandingZoneOperationOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*GetLandingZoneOperationOutput) SetOperationDetails ¶ added in v1.48.4
func (s *GetLandingZoneOperationOutput) SetOperationDetails(v *LandingZoneOperationDetail) *GetLandingZoneOperationOutput
SetOperationDetails sets the OperationDetails field's value.
func (GetLandingZoneOperationOutput) String ¶ added in v1.48.4
func (s GetLandingZoneOperationOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InternalServerException ¶
type InternalServerException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
An unexpected error occurred during processing of a request.
func (*InternalServerException) Code ¶
func (s *InternalServerException) Code() string
Code returns the exception type name.
func (*InternalServerException) Error ¶
func (s *InternalServerException) Error() string
func (InternalServerException) GoString ¶
func (s InternalServerException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*InternalServerException) Message ¶
func (s *InternalServerException) Message() string
Message returns the exception's message.
func (*InternalServerException) OrigErr ¶
func (s *InternalServerException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*InternalServerException) RequestID ¶
func (s *InternalServerException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*InternalServerException) StatusCode ¶
func (s *InternalServerException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (InternalServerException) String ¶
func (s InternalServerException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LandingZoneOperationDetail ¶ added in v1.48.4
type LandingZoneOperationDetail struct { // The landing zone operation end time. EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` // The landing zone operation type. // // Valid values: // // * DELETE: The DeleteLandingZone operation. // // * CREATE: The CreateLandingZone operation. // // * UPDATE: The UpdateLandingZone operation. // // * RESET: The ResetLandingZone operation. OperationType *string `locationName:"operationType" type:"string" enum:"LandingZoneOperationType"` // The landing zone operation start time. StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` // Valid values: // // * SUCCEEDED: The landing zone operation succeeded. // // * IN_PROGRESS: The landing zone operation is in progress. // // * FAILED: The landing zone operation failed. Status *string `locationName:"status" type:"string" enum:"LandingZoneOperationStatus"` // If the operation result is FAILED, this string contains a message explaining // why the operation failed. StatusMessage *string `locationName:"statusMessage" type:"string"` // contains filtered or unexported fields }
Information about a landing zone operation.
func (LandingZoneOperationDetail) GoString ¶ added in v1.48.4
func (s LandingZoneOperationDetail) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*LandingZoneOperationDetail) SetEndTime ¶ added in v1.48.4
func (s *LandingZoneOperationDetail) SetEndTime(v time.Time) *LandingZoneOperationDetail
SetEndTime sets the EndTime field's value.
func (*LandingZoneOperationDetail) SetOperationType ¶ added in v1.48.4
func (s *LandingZoneOperationDetail) SetOperationType(v string) *LandingZoneOperationDetail
SetOperationType sets the OperationType field's value.
func (*LandingZoneOperationDetail) SetStartTime ¶ added in v1.48.4
func (s *LandingZoneOperationDetail) SetStartTime(v time.Time) *LandingZoneOperationDetail
SetStartTime sets the StartTime field's value.
func (*LandingZoneOperationDetail) SetStatus ¶ added in v1.48.4
func (s *LandingZoneOperationDetail) SetStatus(v string) *LandingZoneOperationDetail
SetStatus sets the Status field's value.
func (*LandingZoneOperationDetail) SetStatusMessage ¶ added in v1.48.4
func (s *LandingZoneOperationDetail) SetStatusMessage(v string) *LandingZoneOperationDetail
SetStatusMessage sets the StatusMessage field's value.
func (LandingZoneOperationDetail) String ¶ added in v1.48.4
func (s LandingZoneOperationDetail) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type LandingZoneSummary ¶ added in v1.48.4
type LandingZoneSummary struct { // The ARN of the landing zone. Arn *string `locationName:"arn" min:"20" type:"string"` // contains filtered or unexported fields }
Returns a summary of information about a landing zone.
func (LandingZoneSummary) GoString ¶ added in v1.48.4
func (s LandingZoneSummary) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*LandingZoneSummary) SetArn ¶ added in v1.48.4
func (s *LandingZoneSummary) SetArn(v string) *LandingZoneSummary
SetArn sets the Arn field's value.
func (LandingZoneSummary) String ¶ added in v1.48.4
func (s LandingZoneSummary) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListEnabledControlsInput ¶
type ListEnabledControlsInput struct { // How many results to return per API call. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token to continue the list from a previous API call with the same parameters. NextToken *string `locationName:"nextToken" type:"string"` // The ARN of the organizational unit. For information on how to find the targetIdentifier, // see the overview page (https://docs.aws.amazon.com/controltower/latest/APIReference/Welcome.html). // // TargetIdentifier is a required field TargetIdentifier *string `locationName:"targetIdentifier" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListEnabledControlsInput) GoString ¶
func (s ListEnabledControlsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListEnabledControlsInput) SetMaxResults ¶
func (s *ListEnabledControlsInput) SetMaxResults(v int64) *ListEnabledControlsInput
SetMaxResults sets the MaxResults field's value.
func (*ListEnabledControlsInput) SetNextToken ¶
func (s *ListEnabledControlsInput) SetNextToken(v string) *ListEnabledControlsInput
SetNextToken sets the NextToken field's value.
func (*ListEnabledControlsInput) SetTargetIdentifier ¶
func (s *ListEnabledControlsInput) SetTargetIdentifier(v string) *ListEnabledControlsInput
SetTargetIdentifier sets the TargetIdentifier field's value.
func (ListEnabledControlsInput) String ¶
func (s ListEnabledControlsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListEnabledControlsInput) Validate ¶
func (s *ListEnabledControlsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListEnabledControlsOutput ¶
type ListEnabledControlsOutput struct { // Lists the controls enabled by Amazon Web Services Control Tower on the specified // organizational unit and the accounts it contains. // // EnabledControls is a required field EnabledControls []*EnabledControlSummary `locationName:"enabledControls" type:"list" required:"true"` // Retrieves the next page of results. If the string is empty, the response // is the end of the results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListEnabledControlsOutput) GoString ¶
func (s ListEnabledControlsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListEnabledControlsOutput) SetEnabledControls ¶
func (s *ListEnabledControlsOutput) SetEnabledControls(v []*EnabledControlSummary) *ListEnabledControlsOutput
SetEnabledControls sets the EnabledControls field's value.
func (*ListEnabledControlsOutput) SetNextToken ¶
func (s *ListEnabledControlsOutput) SetNextToken(v string) *ListEnabledControlsOutput
SetNextToken sets the NextToken field's value.
func (ListEnabledControlsOutput) String ¶
func (s ListEnabledControlsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListLandingZonesInput ¶ added in v1.48.4
type ListLandingZonesInput struct { // The maximum number of returned landing zone ARNs, which is one. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` // The token to continue the list from a previous API call with the same parameters. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListLandingZonesInput) GoString ¶ added in v1.48.4
func (s ListLandingZonesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListLandingZonesInput) SetMaxResults ¶ added in v1.48.4
func (s *ListLandingZonesInput) SetMaxResults(v int64) *ListLandingZonesInput
SetMaxResults sets the MaxResults field's value.
func (*ListLandingZonesInput) SetNextToken ¶ added in v1.48.4
func (s *ListLandingZonesInput) SetNextToken(v string) *ListLandingZonesInput
SetNextToken sets the NextToken field's value.
func (ListLandingZonesInput) String ¶ added in v1.48.4
func (s ListLandingZonesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListLandingZonesInput) Validate ¶ added in v1.48.4
func (s *ListLandingZonesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListLandingZonesOutput ¶ added in v1.48.4
type ListLandingZonesOutput struct { // The ARN of the landing zone. // // LandingZones is a required field LandingZones []*LandingZoneSummary `locationName:"landingZones" type:"list" required:"true"` // Retrieves the next page of results. If the string is empty, the response // is the end of the results. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListLandingZonesOutput) GoString ¶ added in v1.48.4
func (s ListLandingZonesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListLandingZonesOutput) SetLandingZones ¶ added in v1.48.4
func (s *ListLandingZonesOutput) SetLandingZones(v []*LandingZoneSummary) *ListLandingZonesOutput
SetLandingZones sets the LandingZones field's value.
func (*ListLandingZonesOutput) SetNextToken ¶ added in v1.48.4
func (s *ListLandingZonesOutput) SetNextToken(v string) *ListLandingZonesOutput
SetNextToken sets the NextToken field's value.
func (ListLandingZonesOutput) String ¶ added in v1.48.4
func (s ListLandingZonesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsForResourceInput ¶ added in v1.47.9
type ListTagsForResourceInput struct { // The ARN of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶ added in v1.47.9
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) SetResourceArn ¶ added in v1.47.9
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (ListTagsForResourceInput) String ¶ added in v1.47.9
func (s ListTagsForResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceInput) Validate ¶ added in v1.47.9
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶ added in v1.47.9
type ListTagsForResourceOutput struct { // A list of tags, as key:value strings. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶ added in v1.47.9
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ListTagsForResourceOutput) SetTags ¶ added in v1.47.9
func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶ added in v1.47.9
func (s ListTagsForResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Region ¶ added in v1.45.25
type Region struct { // The Amazon Web Services Region name. Name *string `locationName:"name" min:"1" type:"string"` // contains filtered or unexported fields }
An Amazon Web Services Region in which Amazon Web Services Control Tower expects to find the control deployed.
The expected Regions are based on the Regions that are governed by the landing zone. In certain cases, a control is not actually enabled in the Region as expected, such as during drift, or mixed governance (https://docs.aws.amazon.com/controltower/latest/userguide/region-how.html#mixed-governance).
func (Region) GoString ¶ added in v1.45.25
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResetLandingZoneInput ¶ added in v1.48.4
type ResetLandingZoneInput struct { // The unique identifier of the landing zone. // // LandingZoneIdentifier is a required field LandingZoneIdentifier *string `locationName:"landingZoneIdentifier" type:"string" required:"true"` // contains filtered or unexported fields }
func (ResetLandingZoneInput) GoString ¶ added in v1.48.4
func (s ResetLandingZoneInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResetLandingZoneInput) SetLandingZoneIdentifier ¶ added in v1.48.4
func (s *ResetLandingZoneInput) SetLandingZoneIdentifier(v string) *ResetLandingZoneInput
SetLandingZoneIdentifier sets the LandingZoneIdentifier field's value.
func (ResetLandingZoneInput) String ¶ added in v1.48.4
func (s ResetLandingZoneInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResetLandingZoneInput) Validate ¶ added in v1.48.4
func (s *ResetLandingZoneInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ResetLandingZoneOutput ¶ added in v1.48.4
type ResetLandingZoneOutput struct { // A unique identifier assigned to a ResetLandingZone operation. You can use // this identifier as an input parameter of GetLandingZoneOperation to check // the operation's status. // // OperationIdentifier is a required field OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string" required:"true"` // contains filtered or unexported fields }
func (ResetLandingZoneOutput) GoString ¶ added in v1.48.4
func (s ResetLandingZoneOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResetLandingZoneOutput) SetOperationIdentifier ¶ added in v1.48.4
func (s *ResetLandingZoneOutput) SetOperationIdentifier(v string) *ResetLandingZoneOutput
SetOperationIdentifier sets the OperationIdentifier field's value.
func (ResetLandingZoneOutput) String ¶ added in v1.48.4
func (s ResetLandingZoneOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ResourceNotFoundException ¶
type ResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request references a resource that does not exist.
func (*ResourceNotFoundException) Code ¶
func (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (*ResourceNotFoundException) Error ¶
func (s *ResourceNotFoundException) Error() string
func (ResourceNotFoundException) GoString ¶
func (s ResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ResourceNotFoundException) Message ¶
func (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (*ResourceNotFoundException) OrigErr ¶
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ResourceNotFoundException) RequestID ¶
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ResourceNotFoundException) StatusCode ¶
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ResourceNotFoundException) String ¶
func (s ResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.
func (*ServiceQuotaExceededException) Code ¶
func (s *ServiceQuotaExceededException) Code() string
Code returns the exception type name.
func (*ServiceQuotaExceededException) Error ¶
func (s *ServiceQuotaExceededException) Error() string
func (ServiceQuotaExceededException) GoString ¶
func (s ServiceQuotaExceededException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ServiceQuotaExceededException) Message ¶
func (s *ServiceQuotaExceededException) Message() string
Message returns the exception's message.
func (*ServiceQuotaExceededException) OrigErr ¶
func (s *ServiceQuotaExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ServiceQuotaExceededException) RequestID ¶
func (s *ServiceQuotaExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ServiceQuotaExceededException) StatusCode ¶
func (s *ServiceQuotaExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ServiceQuotaExceededException) String ¶
func (s ServiceQuotaExceededException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type TagResourceInput ¶ added in v1.47.9
type TagResourceInput struct { // The ARN of the resource to be tagged. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // Tags to be applied to the resource. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` // contains filtered or unexported fields }
func (TagResourceInput) GoString ¶ added in v1.47.9
func (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) SetResourceArn ¶ added in v1.47.9
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*TagResourceInput) SetTags ¶ added in v1.47.9
func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶ added in v1.47.9
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*TagResourceInput) Validate ¶ added in v1.47.9
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶ added in v1.47.9
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) GoString ¶ added in v1.47.9
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (TagResourceOutput) String ¶ added in v1.47.9
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ThrottlingException ¶
type ThrottlingException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // The ID of the service quota that was exceeded. QuotaCode *string `locationName:"quotaCode" type:"string"` // The number of seconds to wait before retrying. RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` // The ID of the service that is associated with the error. ServiceCode *string `locationName:"serviceCode" type:"string"` // contains filtered or unexported fields }
The request was denied due to request throttling.
func (*ThrottlingException) Code ¶
func (s *ThrottlingException) Code() string
Code returns the exception type name.
func (*ThrottlingException) Error ¶
func (s *ThrottlingException) Error() string
func (ThrottlingException) GoString ¶
func (s ThrottlingException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ThrottlingException) Message ¶
func (s *ThrottlingException) Message() string
Message returns the exception's message.
func (*ThrottlingException) OrigErr ¶
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ThrottlingException) RequestID ¶
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ThrottlingException) StatusCode ¶
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ThrottlingException) String ¶
func (s ThrottlingException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagResourceInput ¶ added in v1.47.9
type UntagResourceInput struct { // The ARN of the resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" min:"20" type:"string" required:"true"` // Tag keys to be removed from the resource. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` // contains filtered or unexported fields }
func (UntagResourceInput) GoString ¶ added in v1.47.9
func (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) SetResourceArn ¶ added in v1.47.9
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*UntagResourceInput) SetTagKeys ¶ added in v1.47.9
func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput
SetTagKeys sets the TagKeys field's value.
func (UntagResourceInput) String ¶ added in v1.47.9
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*UntagResourceInput) Validate ¶ added in v1.47.9
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶ added in v1.47.9
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) GoString ¶ added in v1.47.9
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (UntagResourceOutput) String ¶ added in v1.47.9
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ValidationException ¶
type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
The input does not satisfy the constraints specified by an Amazon Web Services service.
func (*ValidationException) Code ¶
func (s *ValidationException) Code() string
Code returns the exception type name.
func (*ValidationException) Error ¶
func (s *ValidationException) Error() string
func (ValidationException) GoString ¶
func (s ValidationException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (*ValidationException) Message ¶
func (s *ValidationException) Message() string
Message returns the exception's message.
func (*ValidationException) OrigErr ¶
func (s *ValidationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (*ValidationException) RequestID ¶
func (s *ValidationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (*ValidationException) StatusCode ¶
func (s *ValidationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (ValidationException) String ¶
func (s ValidationException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
Directories ¶
Path | Synopsis |
---|---|
Package controltoweriface provides an interface to enable mocking the AWS Control Tower service client for testing your code.
|
Package controltoweriface provides an interface to enable mocking the AWS Control Tower service client for testing your code. |