types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 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 BaselineOperation 

type BaselineOperation struct {

	// The end time of the operation (if applicable), in ISO 8601 format.
	EndTime *time.Time

	// The identifier of the specified operation.
	OperationIdentifier *string

	// An enumerated type ( enum ) with possible values of ENABLE_BASELINE ,
	// DISABLE_BASELINE , UPDATE_ENABLED_BASELINE , or RESET_ENABLED_BASELINE .
	OperationType BaselineOperationType

	// The start time of the operation, in ISO 8601 format.
	StartTime *time.Time

	// An enumerated type ( enum ) with possible values of SUCCEEDED , FAILED , or
	// IN_PROGRESS .
	Status BaselineOperationStatus

	// A status message that gives more information about the operation's status, if
	// applicable.
	StatusMessage *string
	// contains filtered or unexported fields
}

An object of shape BaselineOperation , returning details about the specified Baseline operation ID.

type BaselineOperationStatus 

type BaselineOperationStatus string
const (
	BaselineOperationStatusSucceeded  BaselineOperationStatus = "SUCCEEDED"
	BaselineOperationStatusFailed     BaselineOperationStatus = "FAILED"
	BaselineOperationStatusInProgress BaselineOperationStatus = "IN_PROGRESS"
)

Enum values for BaselineOperationStatus

func (BaselineOperationStatus) Values 

func (BaselineOperationStatus) Values() []BaselineOperationStatus

Values returns all known values for BaselineOperationStatus. 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 BaselineOperationType 

type BaselineOperationType string
const (
	BaselineOperationTypeEnableBaseline        BaselineOperationType = "ENABLE_BASELINE"
	BaselineOperationTypeDisableBaseline       BaselineOperationType = "DISABLE_BASELINE"
	BaselineOperationTypeUpdateEnabledBaseline BaselineOperationType = "UPDATE_ENABLED_BASELINE"
	BaselineOperationTypeResetEnabledBaseline  BaselineOperationType = "RESET_ENABLED_BASELINE"
)

Enum values for BaselineOperationType

func (BaselineOperationType) Values 

func (BaselineOperationType) Values() []BaselineOperationType

Values returns all known values for BaselineOperationType. 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 BaselineSummary 

type BaselineSummary struct {

	// The full ARN of a Baseline.
	//
	// This member is required.
	Arn *string

	// The human-readable name of a Baseline.
	//
	// This member is required.
	Name *string

	// A summary description of a Baseline.
	Description *string
	// contains filtered or unexported fields
}

Returns a summary of information about a Baseline object.

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 controlIdentifier of the control for the operation.
	ControlIdentifier *string

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

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

	// The identifier of the specified operation.
	OperationIdentifier *string

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

	// The target upon which the control operation is working.
	TargetIdentifier *string
	// contains filtered or unexported fields
}

An operation performed by the control.

type ControlOperationFilter 

type ControlOperationFilter struct {

	// The set of controlIdentifier returned by the filter.
	ControlIdentifiers []string

	// The set of ControlOperation objects returned by the filter.
	ControlOperationTypes []ControlOperationType

	// The set controlIdentifier of enabled controls selected by the filter.
	EnabledControlIdentifiers []string

	// Lists the status of control operations.
	Statuses []ControlOperationStatus

	// The set of targetIdentifier objects returned by the filter.
	TargetIdentifiers []string
	// contains filtered or unexported fields
}

A filter object that lets you call ListCOntrolOperations with a specific filter.

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 ControlOperationSummary 

type ControlOperationSummary struct {

	// The controlIdentifier of a control.
	ControlIdentifier *string

	// The controlIdentifier of an enabled control.
	EnabledControlIdentifier *string

	// The time at which the control operation was completed.
	EndTime *time.Time

	// The unique identifier of a control operation.
	OperationIdentifier *string

	// The type of operation.
	OperationType ControlOperationType

	// The time at which a control operation began.
	StartTime *time.Time

	// The status of the specified control operation.
	Status ControlOperationStatus

	// A speficic message displayed as part of the control status.
	StatusMessage *string

	// The unique identifier of the target of a control operation.
	TargetIdentifier *string
	// contains filtered or unexported fields
}

A summary of information about the specified control operation.

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 

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 

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 

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 EnabledBaselineDetails 

type EnabledBaselineDetails struct {

	// The ARN of the EnabledBaseline resource.
	//
	// This member is required.
	Arn *string

	// The specific Baseline enabled as part of the EnabledBaseline resource.
	//
	// This member is required.
	BaselineIdentifier *string

	// The deployment summary of the enabled control.
	//
	// This member is required.
	StatusSummary *EnablementStatusSummary

	// The target on which to enable the Baseline .
	//
	// This member is required.
	TargetIdentifier *string

	// The enabled version of the Baseline .
	BaselineVersion *string

	// Shows the parameters that are applied when enabling this Baseline .
	Parameters []EnabledBaselineParameterSummary
	// contains filtered or unexported fields
}

Details of the EnabledBaseline resource.

type EnabledBaselineFilter 

type EnabledBaselineFilter struct {

	// Identifiers for the Baseline objects returned as part of the filter operation.
	BaselineIdentifiers []string

	// Identifiers for the targets of the Baseline filter operation.
	TargetIdentifiers []string
	// contains filtered or unexported fields
}

A filter applied on the ListEnabledBaseline operation. Allowed filters are baselineIdentifiers and targetIdentifiers . The filter can be applied for either, or both.

type EnabledBaselineParameter 

type EnabledBaselineParameter struct {

	// A string denoting the parameter key.
	//
	// This member is required.
	Key *string

	// A low-level Document object of any type (for example, a Java Object).
	//
	// This member is required.
	Value document.Interface
	// contains filtered or unexported fields
}

A key-value parameter to an EnabledBaseline resource.

type EnabledBaselineParameterSummary 

type EnabledBaselineParameterSummary struct {

	// A string denoting the parameter key.
	//
	// This member is required.
	Key *string

	// A low-level document object of any type (for example, a Java Object).
	//
	// This member is required.
	Value document.Interface
	// contains filtered or unexported fields
}

Summary of an applied parameter to an EnabledBaseline resource.

type EnabledBaselineSummary 

type EnabledBaselineSummary struct {

	// The ARN of the EnabledBaseline resource
	//
	// This member is required.
	Arn *string

	// The specific baseline that is enabled as part of the EnabledBaseline resource.
	//
	// This member is required.
	BaselineIdentifier *string

	// The deployment summary of the enabled control.
	//
	// This member is required.
	StatusSummary *EnablementStatusSummary

	// The target upon which the baseline is enabled.
	//
	// This member is required.
	TargetIdentifier *string

	// The enabled version of the baseline.
	BaselineVersion *string
	// contains filtered or unexported fields
}

Returns a summary of information about an EnabledBaseline object.

type EnabledControlDetails 

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].
	//
	// [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].
	//
	// [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 EnabledControlFilter 

type EnabledControlFilter struct {

	// The set of controlIdentifier returned by the filter.
	ControlIdentifiers []string

	// A list of DriftStatus items.
	DriftStatuses []DriftStatus

	// A list of EnablementStatus items.
	Statuses []EnablementStatus
	// contains filtered or unexported fields
}

A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.

type EnabledControlParameter 

type EnabledControlParameter 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
}

A key/value pair, where Key is of type String and Value is of type Document .

type EnabledControlParameterSummary 

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 

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

Enum values for EnablementStatus

func (EnablementStatus) Values 

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 

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 

type LandingZoneDetail struct {

	// The landing zone manifest JSON 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. One of ACTIVE , PROCESSING , FAILED .
	Status LandingZoneStatus
	// contains filtered or unexported fields
}

Information about the landing zone.

type LandingZoneDriftStatus 

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

Enum values for LandingZoneDriftStatus

func (LandingZoneDriftStatus) Values 

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 

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 

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 

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

Enum values for LandingZoneOperationStatus

func (LandingZoneOperationStatus) Values 

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 

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

Enum values for LandingZoneOperationType

func (LandingZoneOperationType) Values 

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 

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

Enum values for LandingZoneStatus

func (LandingZoneStatus) Values 

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 

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 

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.

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.