types

package
v1.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 1, 2023 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Updating or deleting the resource can cause an inconsistent state.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ControlOperation 

type ControlOperation struct {

	// The time that the operation finished.
	EndTime *time.Time

	// One of ENABLE_CONTROL or DISABLE_CONTROL .
	OperationType ControlOperationType

	// The time that the operation began.
	StartTime *time.Time

	// One of IN_PROGRESS , SUCEEDED , or FAILED .
	Status ControlOperationStatus

	// If the operation result is FAILED , this string contains a message explaining
	// why the operation failed.
	StatusMessage *string
	// contains filtered or unexported fields
}

An operation performed by the control.

type ControlOperationStatus 

type ControlOperationStatus string
const (
	ControlOperationStatusSucceeded  ControlOperationStatus = "SUCCEEDED"
	ControlOperationStatusFailed     ControlOperationStatus = "FAILED"
	ControlOperationStatusInProgress ControlOperationStatus = "IN_PROGRESS"
)

Enum values for ControlOperationStatus

func (ControlOperationStatus) Values 

func (ControlOperationStatus) Values() []ControlOperationStatus

Values returns all known values for ControlOperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ControlOperationType 

type ControlOperationType string
const (
	ControlOperationTypeEnableControl        ControlOperationType = "ENABLE_CONTROL"
	ControlOperationTypeDisableControl       ControlOperationType = "DISABLE_CONTROL"
	ControlOperationTypeUpdateEnabledControl ControlOperationType = "UPDATE_ENABLED_CONTROL"
)

Enum values for ControlOperationType

func (ControlOperationType) Values 

func (ControlOperationType) Values() []ControlOperationType

Values returns all known values for ControlOperationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DriftStatus added in v1.4.0 

type DriftStatus string
const (
	DriftStatusDrifted     DriftStatus = "DRIFTED"
	DriftStatusInSync      DriftStatus = "IN_SYNC"
	DriftStatusNotChecking DriftStatus = "NOT_CHECKING"
	DriftStatusUnknown     DriftStatus = "UNKNOWN"
)

Enum values for DriftStatus

func (DriftStatus) Values added in v1.4.0 

func (DriftStatus) Values() []DriftStatus

Values returns all known values for DriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type DriftStatusSummary added in v1.4.0 

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 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.

type EnabledControlDetails added in v1.4.0 

type EnabledControlDetails struct {

	// The ARN of the enabled control.
	Arn *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

	// The drift status of the enabled control.
	DriftStatusSummary *DriftStatusSummary

	// Array of EnabledControlParameter objects.
	Parameters []EnabledControlParameterSummary

	// The deployment summary of the enabled control.
	StatusSummary *EnablementStatusSummary

	// 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

	// Target Amazon Web Services Regions for the enabled control.
	TargetRegions []Region
	// contains filtered or unexported fields
}

Information about the enabled control.

type EnabledControlParameter added in v1.9.0 

type EnabledControlParameter struct {

	// The key of a key/value pair. It is of type string .
	//
	// This member is required.
	Key *string

	// The value of a key/value pair. It can be of type array string , number , object
	// , or boolean .
	//
	// This member is required.
	Value document.Interface
	// contains filtered or unexported fields
}

A set of parameters that configure the behavior of the enabled control. A key/value pair, where Key is of type String and Value is of type Document .

type EnabledControlParameterSummary added in v1.9.0 

type EnabledControlParameterSummary struct {

	// The key of a key/value pair.
	//
	// This member is required.
	Key *string

	// The value of a key/value pair.
	//
	// This member is required.
	Value document.Interface
	// contains filtered or unexported fields
}

Returns a summary of information about the parameters of an enabled control.

type EnabledControlSummary 

type EnabledControlSummary struct {

	// The ARN of the enabled control.
	Arn *string

	// The controlIdentifier of the enabled control.
	ControlIdentifier *string

	// The drift status of the enabled control.
	DriftStatusSummary *DriftStatusSummary

	// A short description of the status of the enabled control.
	StatusSummary *EnablementStatusSummary

	// The ARN of the organizational unit.
	TargetIdentifier *string
	// contains filtered or unexported fields
}

Returns a summary of information about an enabled control.

type EnablementStatus added in v1.4.0 

type EnablementStatus string
const (
	EnablementStatusSucceeded   EnablementStatus = "SUCCEEDED"
	EnablementStatusFailed      EnablementStatus = "FAILED"
	EnablementStatusUnderChange EnablementStatus = "UNDER_CHANGE"
)

Enum values for EnablementStatus

func (EnablementStatus) Values added in v1.4.0 

func (EnablementStatus) Values() []EnablementStatus

Values returns all known values for EnablementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type EnablementStatusSummary added in v1.4.0 

type EnablementStatusSummary struct {

	// The last operation identifier for the enabled control.
	LastOperationIdentifier *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 EnablementStatus
	// contains filtered or unexported fields
}

The deployment summary of the enabled control.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An unexpected error occurred during processing of a request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LandingZoneDetail added in v1.8.0 

type LandingZoneDetail struct {

	// The landing zone manifest.yaml text file that specifies the landing zone
	// configurations.
	//
	// This member is required.
	Manifest document.Interface

	// The landing zone's current deployed version.
	//
	// This member is required.
	Version *string

	// The ARN of the landing zone.
	Arn *string

	// The drift status of the landing zone.
	DriftStatus *LandingZoneDriftStatusSummary

	// The latest available version of the landing zone.
	LatestAvailableVersion *string

	// The landing zone deployment status.
	Status LandingZoneStatus
	// contains filtered or unexported fields
}

Information about the landing zone.

type LandingZoneDriftStatus added in v1.8.0 

type LandingZoneDriftStatus string
const (
	LandingZoneDriftStatusDrifted LandingZoneDriftStatus = "DRIFTED"
	LandingZoneDriftStatusInSync  LandingZoneDriftStatus = "IN_SYNC"
)

Enum values for LandingZoneDriftStatus

func (LandingZoneDriftStatus) Values added in v1.8.0 

func (LandingZoneDriftStatus) Values() []LandingZoneDriftStatus

Values returns all known values for LandingZoneDriftStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LandingZoneDriftStatusSummary added in v1.8.0 

type LandingZoneDriftStatusSummary struct {

	// The drift status of the landing zone. Valid values:
	//   - DRIFTED : The landing zone deployed in this configuration does not match the
	//   configuration that Amazon Web Services Control Tower expected.
	//   - IN_SYNC : The landing zone deployed in this configuration matches the
	//   configuration that Amazon Web Services Control Tower expected.
	Status LandingZoneDriftStatus
	// contains filtered or unexported fields
}

The drift status summary of the landing zone. If the landing zone differs from the expected configuration, it is defined to be in a state of drift. You can repair this drift by resetting the landing zone.

type LandingZoneOperationDetail added in v1.8.0 

type LandingZoneOperationDetail struct {

	// The landing zone operation end time.
	EndTime *time.Time

	// The landing zone operation type. Valid values:
	//   - DELETE : The DeleteLandingZone operation.
	//   - CREATE : The CreateLandingZone operation.
	//   - UPDATE : The UpdateLandingZone operation.
	//   - RESET : The ResetLandingZone operation.
	OperationType LandingZoneOperationType

	// The landing zone operation start time.
	StartTime *time.Time

	// Valid values:
	//   - SUCCEEDED : The landing zone operation succeeded.
	//   - IN_PROGRESS : The landing zone operation is in progress.
	//   - FAILED : The landing zone operation failed.
	Status LandingZoneOperationStatus

	// If the operation result is FAILED, this string contains a message explaining
	// why the operation failed.
	StatusMessage *string
	// contains filtered or unexported fields
}

Information about a landing zone operation.

type LandingZoneOperationStatus added in v1.8.0 

type LandingZoneOperationStatus string
const (
	LandingZoneOperationStatusSucceeded  LandingZoneOperationStatus = "SUCCEEDED"
	LandingZoneOperationStatusFailed     LandingZoneOperationStatus = "FAILED"
	LandingZoneOperationStatusInProgress LandingZoneOperationStatus = "IN_PROGRESS"
)

Enum values for LandingZoneOperationStatus

func (LandingZoneOperationStatus) Values added in v1.8.0 

func (LandingZoneOperationStatus) Values() []LandingZoneOperationStatus

Values returns all known values for LandingZoneOperationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LandingZoneOperationType added in v1.8.0 

type LandingZoneOperationType string
const (
	LandingZoneOperationTypeDelete LandingZoneOperationType = "DELETE"
	LandingZoneOperationTypeCreate LandingZoneOperationType = "CREATE"
	LandingZoneOperationTypeUpdate LandingZoneOperationType = "UPDATE"
	LandingZoneOperationTypeReset  LandingZoneOperationType = "RESET"
)

Enum values for LandingZoneOperationType

func (LandingZoneOperationType) Values added in v1.8.0 

func (LandingZoneOperationType) Values() []LandingZoneOperationType

Values returns all known values for LandingZoneOperationType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LandingZoneStatus added in v1.8.0 

type LandingZoneStatus string
const (
	LandingZoneStatusActive     LandingZoneStatus = "ACTIVE"
	LandingZoneStatusProcessing LandingZoneStatus = "PROCESSING"
	LandingZoneStatusFailed     LandingZoneStatus = "FAILED"
)

Enum values for LandingZoneStatus

func (LandingZoneStatus) Values added in v1.8.0 

func (LandingZoneStatus) Values() []LandingZoneStatus

Values returns all known values for LandingZoneStatus. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type LandingZoneSummary added in v1.8.0 

type LandingZoneSummary struct {

	// The ARN of the landing zone.
	Arn *string
	// contains filtered or unexported fields
}

Returns a summary of information about a landing zone.

type Region added in v1.4.0 

type Region struct {

	// The Amazon Web Services Region name.
	Name *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) .

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request references a resource that does not exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request would cause a service quota to be exceeded. The limit is 10 concurrent operations.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input does not satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.