types

package
v1.18.5 Latest Latest
Warning

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

Go to latest
Published: May 8, 2024 License: Apache-2.0 Imports: 4 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlreadyExistsException

type AlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource with the name requested already exists.

func (*AlreadyExistsException) Error

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault

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

func (*AlreadyExistsException) ErrorMessage

func (e *AlreadyExistsException) ErrorMessage() string

type ClientTokenConflictException

type ClientTokenConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified client token has already been used in another resource request.

It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.

func (*ClientTokenConflictException) Error

func (*ClientTokenConflictException) ErrorCode

func (e *ClientTokenConflictException) ErrorCode() string

func (*ClientTokenConflictException) ErrorFault

func (*ClientTokenConflictException) ErrorMessage

func (e *ClientTokenConflictException) ErrorMessage() string

type ConcurrentModificationException

type ConcurrentModificationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is currently being modified by another operation.

func (*ConcurrentModificationException) Error

func (*ConcurrentModificationException) ErrorCode

func (e *ConcurrentModificationException) ErrorCode() string

func (*ConcurrentModificationException) ErrorFault

func (*ConcurrentModificationException) ErrorMessage

func (e *ConcurrentModificationException) ErrorMessage() string

type ConcurrentOperationException

type ConcurrentOperationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Another resource operation is currently being performed on this resource.

func (*ConcurrentOperationException) Error

func (*ConcurrentOperationException) ErrorCode

func (e *ConcurrentOperationException) ErrorCode() string

func (*ConcurrentOperationException) ErrorFault

func (*ConcurrentOperationException) ErrorMessage

func (e *ConcurrentOperationException) ErrorMessage() string

type GeneralServiceException

type GeneralServiceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.

func (*GeneralServiceException) Error

func (e *GeneralServiceException) Error() string

func (*GeneralServiceException) ErrorCode

func (e *GeneralServiceException) ErrorCode() string

func (*GeneralServiceException) ErrorFault

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

func (*GeneralServiceException) ErrorMessage

func (e *GeneralServiceException) ErrorMessage() string

type HandlerErrorCode

type HandlerErrorCode string
const (
	HandlerErrorCodeNotUpdatable            HandlerErrorCode = "NotUpdatable"
	HandlerErrorCodeInvalidRequest          HandlerErrorCode = "InvalidRequest"
	HandlerErrorCodeAccessDenied            HandlerErrorCode = "AccessDenied"
	HandlerErrorCodeInvalidCredentials      HandlerErrorCode = "InvalidCredentials"
	HandlerErrorCodeAlreadyExists           HandlerErrorCode = "AlreadyExists"
	HandlerErrorCodeNotFound                HandlerErrorCode = "NotFound"
	HandlerErrorCodeResourceConflict        HandlerErrorCode = "ResourceConflict"
	HandlerErrorCodeThrottling              HandlerErrorCode = "Throttling"
	HandlerErrorCodeServiceLimitExceeded    HandlerErrorCode = "ServiceLimitExceeded"
	HandlerErrorCodeNotStabilized           HandlerErrorCode = "NotStabilized"
	HandlerErrorCodeGeneralServiceException HandlerErrorCode = "GeneralServiceException"
	HandlerErrorCodeServiceInternalError    HandlerErrorCode = "ServiceInternalError"
	HandlerErrorCodeServiceTimeout          HandlerErrorCode = "ServiceTimeout"
	HandlerErrorCodeNetworkFailure          HandlerErrorCode = "NetworkFailure"
	HandlerErrorCodeInternalFailure         HandlerErrorCode = "InternalFailure"
)

Enum values for HandlerErrorCode

func (HandlerErrorCode) Values

Values returns all known values for HandlerErrorCode. 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 HandlerFailureException

type HandlerFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has failed without a returning a more specific error code. This can include timeouts.

func (*HandlerFailureException) Error

func (e *HandlerFailureException) Error() string

func (*HandlerFailureException) ErrorCode

func (e *HandlerFailureException) ErrorCode() string

func (*HandlerFailureException) ErrorFault

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

func (*HandlerFailureException) ErrorMessage

func (e *HandlerFailureException) ErrorMessage() string

type HandlerInternalFailureException

type HandlerInternalFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that an unexpected error occurred within the resource handler.

func (*HandlerInternalFailureException) Error

func (*HandlerInternalFailureException) ErrorCode

func (e *HandlerInternalFailureException) ErrorCode() string

func (*HandlerInternalFailureException) ErrorFault

func (*HandlerInternalFailureException) ErrorMessage

func (e *HandlerInternalFailureException) ErrorMessage() string

type InvalidCredentialsException

type InvalidCredentialsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that the credentials provided by the user are invalid.

func (*InvalidCredentialsException) Error

func (*InvalidCredentialsException) ErrorCode

func (e *InvalidCredentialsException) ErrorCode() string

func (*InvalidCredentialsException) ErrorFault

func (*InvalidCredentialsException) ErrorMessage

func (e *InvalidCredentialsException) ErrorMessage() string

type InvalidRequestException

type InvalidRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that invalid input from the user has generated a generic exception.

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

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

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

type NetworkFailureException

type NetworkFailureException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.

func (*NetworkFailureException) Error

func (e *NetworkFailureException) Error() string

func (*NetworkFailureException) ErrorCode

func (e *NetworkFailureException) ErrorCode() string

func (*NetworkFailureException) ErrorFault

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

func (*NetworkFailureException) ErrorMessage

func (e *NetworkFailureException) ErrorMessage() string

type NotStabilizedException

type NotStabilizedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.

func (*NotStabilizedException) Error

func (e *NotStabilizedException) Error() string

func (*NotStabilizedException) ErrorCode

func (e *NotStabilizedException) ErrorCode() string

func (*NotStabilizedException) ErrorFault

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

func (*NotStabilizedException) ErrorMessage

func (e *NotStabilizedException) ErrorMessage() string

type NotUpdatableException

type NotUpdatableException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.

func (*NotUpdatableException) Error

func (e *NotUpdatableException) Error() string

func (*NotUpdatableException) ErrorCode

func (e *NotUpdatableException) ErrorCode() string

func (*NotUpdatableException) ErrorFault

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

func (*NotUpdatableException) ErrorMessage

func (e *NotUpdatableException) ErrorMessage() string

type Operation

type Operation string
const (
	OperationCreate Operation = "CREATE"
	OperationDelete Operation = "DELETE"
	OperationUpdate Operation = "UPDATE"
)

Enum values for Operation

func (Operation) Values

func (Operation) Values() []Operation

Values returns all known values for Operation. 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 OperationStatus

type OperationStatus string
const (
	OperationStatusPending          OperationStatus = "PENDING"
	OperationStatusInProgress       OperationStatus = "IN_PROGRESS"
	OperationStatusSuccess          OperationStatus = "SUCCESS"
	OperationStatusFailed           OperationStatus = "FAILED"
	OperationStatusCancelInProgress OperationStatus = "CANCEL_IN_PROGRESS"
	OperationStatusCancelComplete   OperationStatus = "CANCEL_COMPLETE"
)

Enum values for OperationStatus

func (OperationStatus) Values

func (OperationStatus) Values() []OperationStatus

Values returns all known values for OperationStatus. 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 PrivateTypeException

type PrivateTypeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.

func (*PrivateTypeException) Error

func (e *PrivateTypeException) Error() string

func (*PrivateTypeException) ErrorCode

func (e *PrivateTypeException) ErrorCode() string

func (*PrivateTypeException) ErrorFault

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

func (*PrivateTypeException) ErrorMessage

func (e *PrivateTypeException) ErrorMessage() string

type ProgressEvent

type ProgressEvent struct {

	// For requests with a status of FAILED , the associated error code.
	//
	// For error code definitions, see [Handler error codes] in the CloudFormation Command Line Interface
	// User Guide for Extension Development.
	//
	// [Handler error codes]: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html
	ErrorCode HandlerErrorCode

	// When the resource operation request was initiated.
	EventTime *time.Time

	// The primary identifier for the resource.
	//
	// In some cases, the resource identifier may be available before the resource
	// operation has reached a status of SUCCESS .
	Identifier *string

	// The resource operation type.
	Operation Operation

	// The current status of the resource operation request.
	//
	//   - PENDING : The resource operation hasn't yet started.
	//
	//   - IN_PROGRESS : The resource operation is currently in progress.
	//
	//   - SUCCESS : The resource operation has successfully completed.
	//
	//   - FAILED : The resource operation has failed. Refer to the error code and
	//   status message for more information.
	//
	//   - CANCEL_IN_PROGRESS : The resource operation is in the process of being
	//   canceled.
	//
	//   - CANCEL_COMPLETE : The resource operation has been canceled.
	OperationStatus OperationStatus

	// The unique token representing this resource operation request.
	//
	// Use the RequestToken with [GetResourceRequestStatus] to return the current status of a resource operation
	// request.
	//
	// [GetResourceRequestStatus]: https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html
	RequestToken *string

	// A JSON string containing the resource model, consisting of each resource
	// property and its current value.
	ResourceModel *string

	// When to next request the status of this resource operation request.
	RetryAfter *time.Time

	// Any message explaining the current status.
	StatusMessage *string

	// The name of the resource type used in the operation.
	TypeName *string
	// contains filtered or unexported fields
}

Represents the current status of a resource operation request. For more information, see Managing resource operation requestsin the Amazon Web Services Cloud Control API User Guide.

type RequestTokenNotFoundException

type RequestTokenNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource operation with the specified request token can't be found.

func (*RequestTokenNotFoundException) Error

func (*RequestTokenNotFoundException) ErrorCode

func (e *RequestTokenNotFoundException) ErrorCode() string

func (*RequestTokenNotFoundException) ErrorFault

func (*RequestTokenNotFoundException) ErrorMessage

func (e *RequestTokenNotFoundException) ErrorMessage() string

type ResourceConflictException

type ResourceConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.

func (*ResourceConflictException) Error

func (e *ResourceConflictException) Error() string

func (*ResourceConflictException) ErrorCode

func (e *ResourceConflictException) ErrorCode() string

func (*ResourceConflictException) ErrorFault

func (*ResourceConflictException) ErrorMessage

func (e *ResourceConflictException) ErrorMessage() string

type ResourceDescription

type ResourceDescription struct {

	// The primary identifier for the resource.
	//
	// For more information, see [Identifying resources] in the Amazon Web Services Cloud Control API User
	// Guide.
	//
	// [Identifying resources]: https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html
	Identifier *string

	// A list of the resource properties and their current values.
	Properties *string
	// contains filtered or unexported fields
}

Represents information about a provisioned resource.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A resource with the specified identifier can't be found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceRequestStatusFilter

type ResourceRequestStatusFilter struct {

	// The operation statuses to include in the filter.
	//
	//   - PENDING : The operation has been requested, but not yet initiated.
	//
	//   - IN_PROGRESS : The operation is in progress.
	//
	//   - SUCCESS : The operation completed.
	//
	//   - FAILED : The operation failed.
	//
	//   - CANCEL_IN_PROGRESS : The operation is in the process of being canceled.
	//
	//   - CANCEL_COMPLETE : The operation has been canceled.
	OperationStatuses []OperationStatus

	// The operation types to include in the filter.
	Operations []Operation
	// contains filtered or unexported fields
}

The filter criteria to use in determining the requests returned.

type ServiceInternalErrorException

type ServiceInternalErrorException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.

func (*ServiceInternalErrorException) Error

func (*ServiceInternalErrorException) ErrorCode

func (e *ServiceInternalErrorException) ErrorCode() string

func (*ServiceInternalErrorException) ErrorFault

func (*ServiceInternalErrorException) ErrorMessage

func (e *ServiceInternalErrorException) ErrorMessage() string

type ServiceLimitExceededException

type ServiceLimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The resource handler has returned that a non-transient resource limit was reached on the service side.

func (*ServiceLimitExceededException) Error

func (*ServiceLimitExceededException) ErrorCode

func (e *ServiceLimitExceededException) ErrorCode() string

func (*ServiceLimitExceededException) ErrorFault

func (*ServiceLimitExceededException) ErrorMessage

func (e *ServiceLimitExceededException) ErrorMessage() string

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// 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 TypeNotFoundException

type TypeNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified extension doesn't exist in the CloudFormation registry.

func (*TypeNotFoundException) Error

func (e *TypeNotFoundException) Error() string

func (*TypeNotFoundException) ErrorCode

func (e *TypeNotFoundException) ErrorCode() string

func (*TypeNotFoundException) ErrorFault

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

func (*TypeNotFoundException) ErrorMessage

func (e *TypeNotFoundException) ErrorMessage() string

type UnsupportedActionException

type UnsupportedActionException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource doesn't support this resource operation.

func (*UnsupportedActionException) Error

func (*UnsupportedActionException) ErrorCode

func (e *UnsupportedActionException) ErrorCode() string

func (*UnsupportedActionException) ErrorFault

func (*UnsupportedActionException) ErrorMessage

func (e *UnsupportedActionException) ErrorMessage() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL