cloudcontrolapi

package
v1.50.2 Latest Latest
Warning

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

 Go to latest Published: Jan 23, 2024 License: Apache-2.0 Imports: 10 Imported by: 23

Documentation

Overview

Package cloudcontrolapi provides the client and types for making API requests to AWS Cloud Control API.

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/what-is-cloudcontrolapi.html).

See https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30 for more information on this service.

See cloudcontrolapi package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudcontrolapi/

Using the Client

To contact AWS Cloud Control API 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 Cloud Control API client CloudControlApi for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudcontrolapi/#New

Index

Constants

View Source 
const (
	// HandlerErrorCodeNotUpdatable is a HandlerErrorCode enum value
	HandlerErrorCodeNotUpdatable = "NotUpdatable"

	// HandlerErrorCodeInvalidRequest is a HandlerErrorCode enum value
	HandlerErrorCodeInvalidRequest = "InvalidRequest"

	// HandlerErrorCodeAccessDenied is a HandlerErrorCode enum value
	HandlerErrorCodeAccessDenied = "AccessDenied"

	// HandlerErrorCodeInvalidCredentials is a HandlerErrorCode enum value
	HandlerErrorCodeInvalidCredentials = "InvalidCredentials"

	// HandlerErrorCodeAlreadyExists is a HandlerErrorCode enum value
	HandlerErrorCodeAlreadyExists = "AlreadyExists"

	// HandlerErrorCodeNotFound is a HandlerErrorCode enum value
	HandlerErrorCodeNotFound = "NotFound"

	// HandlerErrorCodeResourceConflict is a HandlerErrorCode enum value
	HandlerErrorCodeResourceConflict = "ResourceConflict"

	// HandlerErrorCodeThrottling is a HandlerErrorCode enum value
	HandlerErrorCodeThrottling = "Throttling"

	// HandlerErrorCodeServiceLimitExceeded is a HandlerErrorCode enum value
	HandlerErrorCodeServiceLimitExceeded = "ServiceLimitExceeded"

	// HandlerErrorCodeNotStabilized is a HandlerErrorCode enum value
	HandlerErrorCodeNotStabilized = "NotStabilized"

	// HandlerErrorCodeGeneralServiceException is a HandlerErrorCode enum value
	HandlerErrorCodeGeneralServiceException = "GeneralServiceException"

	// HandlerErrorCodeServiceInternalError is a HandlerErrorCode enum value
	HandlerErrorCodeServiceInternalError = "ServiceInternalError"

	// HandlerErrorCodeServiceTimeout is a HandlerErrorCode enum value
	HandlerErrorCodeServiceTimeout = "ServiceTimeout"

	// HandlerErrorCodeNetworkFailure is a HandlerErrorCode enum value
	HandlerErrorCodeNetworkFailure = "NetworkFailure"

	// HandlerErrorCodeInternalFailure is a HandlerErrorCode enum value
	HandlerErrorCodeInternalFailure = "InternalFailure"
)
View Source 
const (
	// OperationCreate is a Operation enum value
	OperationCreate = "CREATE"

	// OperationDelete is a Operation enum value
	OperationDelete = "DELETE"

	// OperationUpdate is a Operation enum value
	OperationUpdate = "UPDATE"
)
View Source 
const (
	// OperationStatusPending is a OperationStatus enum value
	OperationStatusPending = "PENDING"

	// OperationStatusInProgress is a OperationStatus enum value
	OperationStatusInProgress = "IN_PROGRESS"

	// OperationStatusSuccess is a OperationStatus enum value
	OperationStatusSuccess = "SUCCESS"

	// OperationStatusFailed is a OperationStatus enum value
	OperationStatusFailed = "FAILED"

	// OperationStatusCancelInProgress is a OperationStatus enum value
	OperationStatusCancelInProgress = "CANCEL_IN_PROGRESS"

	// OperationStatusCancelComplete is a OperationStatus enum value
	OperationStatusCancelComplete = "CANCEL_COMPLETE"
)
View Source 
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The resource with the name requested already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeClientTokenConflictException for service response error code
	// "ClientTokenConflictException".
	//
	// 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.
	ErrCodeClientTokenConflictException = "ClientTokenConflictException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// The resource is currently being modified by another operation.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeConcurrentOperationException for service response error code
	// "ConcurrentOperationException".
	//
	// Another resource operation is currently being performed on this resource.
	ErrCodeConcurrentOperationException = "ConcurrentOperationException"

	// ErrCodeGeneralServiceException for service response error code
	// "GeneralServiceException".
	//
	// The resource handler has returned that the downstream service generated an
	// error that doesn't map to any other handler error code.
	ErrCodeGeneralServiceException = "GeneralServiceException"

	// ErrCodeHandlerFailureException for service response error code
	// "HandlerFailureException".
	//
	// The resource handler has failed without a returning a more specific error
	// code. This can include timeouts.
	ErrCodeHandlerFailureException = "HandlerFailureException"

	// ErrCodeHandlerInternalFailureException for service response error code
	// "HandlerInternalFailureException".
	//
	// The resource handler has returned that an unexpected error occurred within
	// the resource handler.
	ErrCodeHandlerInternalFailureException = "HandlerInternalFailureException"

	// ErrCodeInvalidCredentialsException for service response error code
	// "InvalidCredentialsException".
	//
	// The resource handler has returned that the credentials provided by the user
	// are invalid.
	ErrCodeInvalidCredentialsException = "InvalidCredentialsException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The resource handler has returned that invalid input from the user has generated
	// a generic exception.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeNetworkFailureException for service response error code
	// "NetworkFailureException".
	//
	// 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.
	ErrCodeNetworkFailureException = "NetworkFailureException"

	// ErrCodeNotStabilizedException for service response error code
	// "NotStabilizedException".
	//
	// The resource handler has returned that the downstream resource failed to
	// complete all of its ready-state checks.
	ErrCodeNotStabilizedException = "NotStabilizedException"

	// ErrCodeNotUpdatableException for service response error code
	// "NotUpdatableException".
	//
	// One or more properties included in this resource operation are defined as
	// create-only, and therefore can't be updated.
	ErrCodeNotUpdatableException = "NotUpdatableException"

	// ErrCodePrivateTypeException for service response error code
	// "PrivateTypeException".
	//
	// 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.
	ErrCodePrivateTypeException = "PrivateTypeException"

	// ErrCodeRequestTokenNotFoundException for service response error code
	// "RequestTokenNotFoundException".
	//
	// A resource operation with the specified request token can't be found.
	ErrCodeRequestTokenNotFoundException = "RequestTokenNotFoundException"

	// ErrCodeResourceConflictException for service response error code
	// "ResourceConflictException".
	//
	// 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.
	ErrCodeResourceConflictException = "ResourceConflictException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource with the specified identifier can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceInternalErrorException for service response error code
	// "ServiceInternalErrorException".
	//
	// The resource handler has returned that the downstream service returned an
	// internal error, typically with a 5XX HTTP status code.
	ErrCodeServiceInternalErrorException = "ServiceInternalErrorException"

	// ErrCodeServiceLimitExceededException for service response error code
	// "ServiceLimitExceededException".
	//
	// The resource handler has returned that a non-transient resource limit was
	// reached on the service side.
	ErrCodeServiceLimitExceededException = "ServiceLimitExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeTypeNotFoundException for service response error code
	// "TypeNotFoundException".
	//
	// The specified extension doesn't exist in the CloudFormation registry.
	ErrCodeTypeNotFoundException = "TypeNotFoundException"

	// ErrCodeUnsupportedActionException for service response error code
	// "UnsupportedActionException".
	//
	// The specified resource doesn't support this resource operation.
	ErrCodeUnsupportedActionException = "UnsupportedActionException"
)
View Source 
const (
	ServiceName = "CloudControl"    // Name of service.
	EndpointsID = "cloudcontrolapi" // ID to lookup a service endpoint with.
	ServiceID   = "CloudControl"    // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func HandlerErrorCode_Values 

func HandlerErrorCode_Values() []string

HandlerErrorCode_Values returns all elements of the HandlerErrorCode enum

func OperationStatus_Values 

func OperationStatus_Values() []string

OperationStatus_Values returns all elements of the OperationStatus enum

func Operation_Values 

func Operation_Values() []string

Operation_Values returns all elements of the Operation enum

Types

type AlreadyExistsException 

type AlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource with the name requested already exists.

func (*AlreadyExistsException) Code 

func (s *AlreadyExistsException) Code() string

Code returns the exception type name.

func (*AlreadyExistsException) Error 

func (s *AlreadyExistsException) Error() string

func (AlreadyExistsException) GoString 

func (s AlreadyExistsException) 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 (*AlreadyExistsException) Message 

func (s *AlreadyExistsException) Message() string

Message returns the exception's message.

func (*AlreadyExistsException) OrigErr 

func (s *AlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AlreadyExistsException) RequestID 

func (s *AlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AlreadyExistsException) StatusCode 

func (s *AlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AlreadyExistsException) String 

func (s AlreadyExistsException) 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 CancelResourceRequestInput 

type CancelResourceRequestInput struct {

	// The RequestToken of the ProgressEvent object returned by the resource operation
	// request.
	//
	// RequestToken is a required field
	RequestToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CancelResourceRequestInput) GoString 

func (s CancelResourceRequestInput) 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 (*CancelResourceRequestInput) SetRequestToken 

func (s *CancelResourceRequestInput) SetRequestToken(v string) *CancelResourceRequestInput

SetRequestToken sets the RequestToken field's value.

func (CancelResourceRequestInput) String 

func (s CancelResourceRequestInput) 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 (*CancelResourceRequestInput) Validate 

func (s *CancelResourceRequestInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelResourceRequestOutput 

type CancelResourceRequestOutput struct {

	// Represents the current status of a resource operation request. For more information,
	// see Managing resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html)
	// in the Amazon Web Services Cloud Control API User Guide.
	ProgressEvent *ProgressEvent `type:"structure"`
	// contains filtered or unexported fields
}

func (CancelResourceRequestOutput) GoString 

func (s CancelResourceRequestOutput) 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 (*CancelResourceRequestOutput) SetProgressEvent 

func (s *CancelResourceRequestOutput) SetProgressEvent(v *ProgressEvent) *CancelResourceRequestOutput

SetProgressEvent sets the ProgressEvent field's value.

func (CancelResourceRequestOutput) String 

func (s CancelResourceRequestOutput) 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 ClientTokenConflictException 

type ClientTokenConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *ClientTokenConflictException) Code() string

Code returns the exception type name.

func (*ClientTokenConflictException) Error 

func (s *ClientTokenConflictException) Error() string

func (ClientTokenConflictException) GoString 

func (s ClientTokenConflictException) 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 (*ClientTokenConflictException) Message 

func (s *ClientTokenConflictException) Message() string

Message returns the exception's message.

func (*ClientTokenConflictException) OrigErr 

func (s *ClientTokenConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ClientTokenConflictException) RequestID 

func (s *ClientTokenConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ClientTokenConflictException) StatusCode 

func (s *ClientTokenConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ClientTokenConflictException) String 

func (s ClientTokenConflictException) 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 CloudControlApi 

type CloudControlApi struct {
	*client.Client
}

CloudControlApi provides the API operation methods for making requests to AWS Cloud Control API. See this package's package overview docs for details on the service.

CloudControlApi 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) *CloudControlApi

New creates a new instance of the CloudControlApi 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 CloudControlApi client from just a session.
svc := cloudcontrolapi.New(mySession)

// Create a CloudControlApi client with additional configuration
svc := cloudcontrolapi.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudControlApi) CancelResourceRequest 

func (c *CloudControlApi) CancelResourceRequest(input *CancelResourceRequestInput) (*CancelResourceRequestOutput, error)

CancelResourceRequest API operation for AWS Cloud Control API.

Cancels the specified resource operation request. For more information, see Canceling resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-cancel) in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be canceled.

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 Cloud Control API's API operation CancelResourceRequest for usage and error information.

Returned Error Types:

  • ConcurrentModificationException The resource is currently being modified by another operation.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/CancelResourceRequest

func (*CloudControlApi) CancelResourceRequestRequest 

func (c *CloudControlApi) CancelResourceRequestRequest(input *CancelResourceRequestInput) (req *request.Request, output *CancelResourceRequestOutput)

CancelResourceRequestRequest generates a "aws/request.Request" representing the client's request for the CancelResourceRequest 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 CancelResourceRequest for more information on using the CancelResourceRequest 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 CancelResourceRequestRequest method.
req, resp := client.CancelResourceRequestRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/CancelResourceRequest

func (*CloudControlApi) CancelResourceRequestWithContext 

func (c *CloudControlApi) CancelResourceRequestWithContext(ctx aws.Context, input *CancelResourceRequestInput, opts ...request.Option) (*CancelResourceRequestOutput, error)

CancelResourceRequestWithContext is the same as CancelResourceRequest with the addition of the ability to pass a context and additional request options.

See CancelResourceRequest 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 (*CloudControlApi) CreateResource 

func (c *CloudControlApi) CreateResource(input *CreateResourceInput) (*CreateResourceOutput, error)

CreateResource API operation for AWS Cloud Control API.

Creates the specified resource. For more information, see Creating a resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html) in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) using the RequestToken of the ProgressEvent type returned by CreateResource.

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 Cloud Control API's API operation CreateResource for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource with the name requested already exists.

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

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

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

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

  • ConcurrentOperationException Another resource operation is currently being performed on this resource.

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

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

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

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

  • UnsupportedActionException The specified resource doesn't support this resource operation.

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

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

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

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

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/CreateResource

func (*CloudControlApi) CreateResourceRequest 

func (c *CloudControlApi) CreateResourceRequest(input *CreateResourceInput) (req *request.Request, output *CreateResourceOutput)

CreateResourceRequest generates a "aws/request.Request" representing the client's request for the CreateResource 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 CreateResource for more information on using the CreateResource 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 CreateResourceRequest method.
req, resp := client.CreateResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/CreateResource

func (*CloudControlApi) CreateResourceWithContext 

func (c *CloudControlApi) CreateResourceWithContext(ctx aws.Context, input *CreateResourceInput, opts ...request.Option) (*CreateResourceOutput, error)

CreateResourceWithContext is the same as CreateResource with the addition of the ability to pass a context and additional request options.

See CreateResource 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 (*CloudControlApi) DeleteResource 

func (c *CloudControlApi) DeleteResource(input *DeleteResourceInput) (*DeleteResourceOutput, error)

DeleteResource API operation for AWS Cloud Control API.

Deletes the specified resource. For details, see Deleting a resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html) in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) using the RequestToken of the ProgressEvent returned by DeleteResource.

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 Cloud Control API's API operation DeleteResource for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource with the name requested already exists.

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

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

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

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

  • ConcurrentOperationException Another resource operation is currently being performed on this resource.

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

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

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

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

  • UnsupportedActionException The specified resource doesn't support this resource operation.

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

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

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

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

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/DeleteResource

func (*CloudControlApi) DeleteResourceRequest 

func (c *CloudControlApi) DeleteResourceRequest(input *DeleteResourceInput) (req *request.Request, output *DeleteResourceOutput)

DeleteResourceRequest generates a "aws/request.Request" representing the client's request for the DeleteResource 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 DeleteResource for more information on using the DeleteResource 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 DeleteResourceRequest method.
req, resp := client.DeleteResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/DeleteResource

func (*CloudControlApi) DeleteResourceWithContext 

func (c *CloudControlApi) DeleteResourceWithContext(ctx aws.Context, input *DeleteResourceInput, opts ...request.Option) (*DeleteResourceOutput, error)

DeleteResourceWithContext is the same as DeleteResource with the addition of the ability to pass a context and additional request options.

See DeleteResource 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 (*CloudControlApi) GetResource 

func (c *CloudControlApi) GetResource(input *GetResourceInput) (*GetResourceOutput, error)

GetResource API operation for AWS Cloud Control API.

Returns information about the current state of the specified resource. For details, see Reading a resource's current state (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html).

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

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 Cloud Control API's API operation GetResource for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource with the name requested already exists.

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

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

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

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

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

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

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

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

  • UnsupportedActionException The specified resource doesn't support this resource operation.

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

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

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

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/GetResource

func (*CloudControlApi) GetResourceRequest 

func (c *CloudControlApi) GetResourceRequest(input *GetResourceInput) (req *request.Request, output *GetResourceOutput)

GetResourceRequest generates a "aws/request.Request" representing the client's request for the GetResource 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 GetResource for more information on using the GetResource 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 GetResourceRequest method.
req, resp := client.GetResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/GetResource

func (*CloudControlApi) GetResourceRequestStatus 

func (c *CloudControlApi) GetResourceRequestStatus(input *GetResourceRequestStatusInput) (*GetResourceRequestStatusOutput, error)

GetResourceRequestStatus API operation for AWS Cloud Control API.

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-track) in the Amazon Web Services Cloud Control API User Guide.

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 Cloud Control API's API operation GetResourceRequestStatus for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/GetResourceRequestStatus

func (*CloudControlApi) GetResourceRequestStatusRequest 

func (c *CloudControlApi) GetResourceRequestStatusRequest(input *GetResourceRequestStatusInput) (req *request.Request, output *GetResourceRequestStatusOutput)

GetResourceRequestStatusRequest generates a "aws/request.Request" representing the client's request for the GetResourceRequestStatus 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 GetResourceRequestStatus for more information on using the GetResourceRequestStatus 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 GetResourceRequestStatusRequest method.
req, resp := client.GetResourceRequestStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/GetResourceRequestStatus

func (*CloudControlApi) GetResourceRequestStatusWithContext 

func (c *CloudControlApi) GetResourceRequestStatusWithContext(ctx aws.Context, input *GetResourceRequestStatusInput, opts ...request.Option) (*GetResourceRequestStatusOutput, error)

GetResourceRequestStatusWithContext is the same as GetResourceRequestStatus with the addition of the ability to pass a context and additional request options.

See GetResourceRequestStatus 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 (*CloudControlApi) GetResourceWithContext 

func (c *CloudControlApi) GetResourceWithContext(ctx aws.Context, input *GetResourceInput, opts ...request.Option) (*GetResourceOutput, error)

GetResourceWithContext is the same as GetResource with the addition of the ability to pass a context and additional request options.

See GetResource 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 (*CloudControlApi) ListResourceRequests 

func (c *CloudControlApi) ListResourceRequests(input *ListResourceRequestsInput) (*ListResourceRequestsOutput, error)

ListResourceRequests API operation for AWS Cloud Control API.

Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html#resource-operations-manage-requests-list) in the Amazon Web Services Cloud Control API User Guide.

Resource operation requests expire after 7 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 Cloud Control API's API operation ListResourceRequests for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/ListResourceRequests

func (*CloudControlApi) ListResourceRequestsPages 

func (c *CloudControlApi) ListResourceRequestsPages(input *ListResourceRequestsInput, fn func(*ListResourceRequestsOutput, bool) bool) error

ListResourceRequestsPages iterates over the pages of a ListResourceRequests operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListResourceRequests 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 ListResourceRequests operation.
pageNum := 0
err := client.ListResourceRequestsPages(params,
    func(page *cloudcontrolapi.ListResourceRequestsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudControlApi) ListResourceRequestsPagesWithContext 

func (c *CloudControlApi) ListResourceRequestsPagesWithContext(ctx aws.Context, input *ListResourceRequestsInput, fn func(*ListResourceRequestsOutput, bool) bool, opts ...request.Option) error

ListResourceRequestsPagesWithContext same as ListResourceRequestsPages 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 (*CloudControlApi) ListResourceRequestsRequest 

func (c *CloudControlApi) ListResourceRequestsRequest(input *ListResourceRequestsInput) (req *request.Request, output *ListResourceRequestsOutput)

ListResourceRequestsRequest generates a "aws/request.Request" representing the client's request for the ListResourceRequests 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 ListResourceRequests for more information on using the ListResourceRequests 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 ListResourceRequestsRequest method.
req, resp := client.ListResourceRequestsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/ListResourceRequests

func (*CloudControlApi) ListResourceRequestsWithContext 

func (c *CloudControlApi) ListResourceRequestsWithContext(ctx aws.Context, input *ListResourceRequestsInput, opts ...request.Option) (*ListResourceRequestsOutput, error)

ListResourceRequestsWithContext is the same as ListResourceRequests with the addition of the ability to pass a context and additional request options.

See ListResourceRequests 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 (*CloudControlApi) ListResources 

func (c *CloudControlApi) ListResources(input *ListResourcesInput) (*ListResourcesOutput, error)

ListResources API operation for AWS Cloud Control API.

Returns information about the specified resources. For more information, see Discovering resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html) in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

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 Cloud Control API's API operation ListResources for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource with the name requested already exists.

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

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

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

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

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

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

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

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

  • UnsupportedActionException The specified resource doesn't support this resource operation.

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

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

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

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/ListResources

func (*CloudControlApi) ListResourcesPages 

func (c *CloudControlApi) ListResourcesPages(input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool) error

ListResourcesPages iterates over the pages of a ListResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListResources 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 ListResources operation.
pageNum := 0
err := client.ListResourcesPages(params,
    func(page *cloudcontrolapi.ListResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudControlApi) ListResourcesPagesWithContext 

func (c *CloudControlApi) ListResourcesPagesWithContext(ctx aws.Context, input *ListResourcesInput, fn func(*ListResourcesOutput, bool) bool, opts ...request.Option) error

ListResourcesPagesWithContext same as ListResourcesPages 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 (*CloudControlApi) ListResourcesRequest 

func (c *CloudControlApi) ListResourcesRequest(input *ListResourcesInput) (req *request.Request, output *ListResourcesOutput)

ListResourcesRequest generates a "aws/request.Request" representing the client's request for the ListResources 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 ListResources for more information on using the ListResources 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 ListResourcesRequest method.
req, resp := client.ListResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/ListResources

func (*CloudControlApi) ListResourcesWithContext 

func (c *CloudControlApi) ListResourcesWithContext(ctx aws.Context, input *ListResourcesInput, opts ...request.Option) (*ListResourcesOutput, error)

ListResourcesWithContext is the same as ListResources with the addition of the ability to pass a context and additional request options.

See ListResources 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 (*CloudControlApi) UpdateResource 

func (c *CloudControlApi) UpdateResource(input *UpdateResourceInput) (*UpdateResourceOutput, error)

UpdateResource API operation for AWS Cloud Control API.

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch (https://datatracker.ietf.org/doc/html/rfc6902) standard.

For details on how Cloud Control API performs resource update operations, see Updating a resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html) in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html) using the RequestToken of the ProgressEvent returned by UpdateResource.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the CloudFormation Users Guide.

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 Cloud Control API's API operation UpdateResource for usage and error information.

Returned Error Types:

  • AlreadyExistsException The resource with the name requested already exists.

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

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

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

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

  • ConcurrentOperationException Another resource operation is currently being performed on this resource.

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

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

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

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

  • UnsupportedActionException The specified resource doesn't support this resource operation.

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

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

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

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

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

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

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

  • ThrottlingException The request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/UpdateResource

func (*CloudControlApi) UpdateResourceRequest 

func (c *CloudControlApi) UpdateResourceRequest(input *UpdateResourceInput) (req *request.Request, output *UpdateResourceOutput)

UpdateResourceRequest generates a "aws/request.Request" representing the client's request for the UpdateResource 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 UpdateResource for more information on using the UpdateResource 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 UpdateResourceRequest method.
req, resp := client.UpdateResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/UpdateResource

func (*CloudControlApi) UpdateResourceWithContext 

func (c *CloudControlApi) UpdateResourceWithContext(ctx aws.Context, input *UpdateResourceInput, opts ...request.Option) (*UpdateResourceOutput, error)

UpdateResourceWithContext is the same as UpdateResource with the addition of the ability to pass a context and additional request options.

See UpdateResource 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 (*CloudControlApi) WaitUntilResourceRequestSuccess 

func (c *CloudControlApi) WaitUntilResourceRequestSuccess(input *GetResourceRequestStatusInput) error

WaitUntilResourceRequestSuccess uses the CloudControlApi API operation GetResourceRequestStatus to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*CloudControlApi) WaitUntilResourceRequestSuccessWithContext 

func (c *CloudControlApi) WaitUntilResourceRequestSuccessWithContext(ctx aws.Context, input *GetResourceRequestStatusInput, opts ...request.WaiterOption) error

WaitUntilResourceRequestSuccessWithContext is an extended version of WaitUntilResourceRequestSuccess. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 ConcurrentModificationException 

type ConcurrentModificationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The resource is currently being modified by another operation.

func (*ConcurrentModificationException) Code 

func (s *ConcurrentModificationException) Code() string

Code returns the exception type name.

func (*ConcurrentModificationException) Error 

func (s *ConcurrentModificationException) Error() string

func (ConcurrentModificationException) GoString 

func (s ConcurrentModificationException) 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 (*ConcurrentModificationException) Message 

func (s *ConcurrentModificationException) Message() string

Message returns the exception's message.

func (*ConcurrentModificationException) OrigErr 

func (s *ConcurrentModificationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentModificationException) RequestID 

func (s *ConcurrentModificationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentModificationException) StatusCode 

func (s *ConcurrentModificationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentModificationException) String 

func (s ConcurrentModificationException) 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 ConcurrentOperationException 

type ConcurrentOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Another resource operation is currently being performed on this resource.

func (*ConcurrentOperationException) Code 

func (s *ConcurrentOperationException) Code() string

Code returns the exception type name.

func (*ConcurrentOperationException) Error 

func (s *ConcurrentOperationException) Error() string

func (ConcurrentOperationException) GoString 

func (s ConcurrentOperationException) 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 (*ConcurrentOperationException) Message 

func (s *ConcurrentOperationException) Message() string

Message returns the exception's message.

func (*ConcurrentOperationException) OrigErr 

func (s *ConcurrentOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConcurrentOperationException) RequestID 

func (s *ConcurrentOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConcurrentOperationException) StatusCode 

func (s *ConcurrentOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConcurrentOperationException) String 

func (s ConcurrentOperationException) 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 CreateResourceInput 

type CreateResourceInput struct {

	// A unique identifier to ensure the idempotency of the resource request. As
	// a best practice, specify this token to ensure idempotency, so that Amazon
	// Web Services Cloud Control API can accurately distinguish between request
	// retries and new resource requests. You might retry a resource request to
	// ensure that it was successfully received.
	//
	// A client token is valid for 36 hours once used. After that, a resource request
	// with the same client token is treated as a new request.
	//
	// If you do not specify a client token, one is generated for inclusion in the
	// request.
	//
	// For more information, see Ensuring resource operation requests are unique
	// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency)
	// in the Amazon Web Services Cloud Control API User Guide.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// Structured data format representing the desired state of the resource, consisting
	// of that resource's properties and their desired values.
	//
	// Cloud Control API currently supports JSON as a structured data format.
	//
	// Specify the desired state as one of the following:
	//
	//    * A JSON blob
	//
	//    * A local path containing the desired state in JSON data format
	//
	// For more information, see Composing the desired state of the resource (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate)
	// in the Amazon Web Services Cloud Control API User Guide.
	//
	// For more information about the properties of a specific resource, refer to
	// the related topic for the resource in the Resource and property types reference
	// (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the CloudFormation Users Guide.
	//
	// DesiredState is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateResourceInput's
	// String and GoString methods.
	//
	// DesiredState is a required field
	DesiredState *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role for Cloud Control API to use when performing this resource operation.
	// The role specified must have the permissions required for this operation.
	// The necessary permissions for each event handler are defined in the handlers
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers)
	// section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html).
	//
	// If you do not specify a role, Cloud Control API uses a temporary session
	// created using your Amazon Web Services user credentials.
	//
	// For more information, see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions)
	// in the Amazon Web Services Cloud Control API User Guide.
	RoleArn *string `min:"20" type:"string"`

	// The name of the resource type.
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`

	// For private resource types, the type version to use in this resource operation.
	// If you do not specify a resource version, CloudFormation uses the default
	// version.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateResourceInput) GoString 

func (s CreateResourceInput) 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 (*CreateResourceInput) SetClientToken 

func (s *CreateResourceInput) SetClientToken(v string) *CreateResourceInput

SetClientToken sets the ClientToken field's value.

func (*CreateResourceInput) SetDesiredState 

func (s *CreateResourceInput) SetDesiredState(v string) *CreateResourceInput

SetDesiredState sets the DesiredState field's value.

func (*CreateResourceInput) SetRoleArn 

func (s *CreateResourceInput) SetRoleArn(v string) *CreateResourceInput

SetRoleArn sets the RoleArn field's value.

func (*CreateResourceInput) SetTypeName 

func (s *CreateResourceInput) SetTypeName(v string) *CreateResourceInput

SetTypeName sets the TypeName field's value.

func (*CreateResourceInput) SetTypeVersionId 

func (s *CreateResourceInput) SetTypeVersionId(v string) *CreateResourceInput

SetTypeVersionId sets the TypeVersionId field's value.

func (CreateResourceInput) String 

func (s CreateResourceInput) 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 (*CreateResourceInput) Validate 

func (s *CreateResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateResourceOutput 

type CreateResourceOutput struct {

	// Represents the current status of the resource creation request.
	//
	// After you have initiated a resource creation request, you can monitor the
	// progress of your request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html)
	// using the RequestToken of the ProgressEvent returned by CreateResource.
	ProgressEvent *ProgressEvent `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateResourceOutput) GoString 

func (s CreateResourceOutput) 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 (*CreateResourceOutput) SetProgressEvent 

func (s *CreateResourceOutput) SetProgressEvent(v *ProgressEvent) *CreateResourceOutput

SetProgressEvent sets the ProgressEvent field's value.

func (CreateResourceOutput) String 

func (s CreateResourceOutput) 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 DeleteResourceInput 

type DeleteResourceInput struct {

	// A unique identifier to ensure the idempotency of the resource request. As
	// a best practice, specify this token to ensure idempotency, so that Amazon
	// Web Services Cloud Control API can accurately distinguish between request
	// retries and new resource requests. You might retry a resource request to
	// ensure that it was successfully received.
	//
	// A client token is valid for 36 hours once used. After that, a resource request
	// with the same client token is treated as a new request.
	//
	// If you do not specify a client token, one is generated for inclusion in the
	// request.
	//
	// For more information, see Ensuring resource operation requests are unique
	// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency)
	// in the Amazon Web Services Cloud Control API User Guide.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The identifier for the resource.
	//
	// You can specify the primary identifier, or any secondary identifier defined
	// for the resource type in its resource schema. You can only specify one identifier.
	// Primary identifiers can be specified as a string or JSON; secondary identifiers
	// must be specified as JSON.
	//
	// For compound primary identifiers (that is, one that consists of multiple
	// resource properties strung together), to specify the primary identifier as
	// a string, list the property values in the order they are specified in the
	// primary identifier definition, separated by |.
	//
	// For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html)
	// in the Amazon Web Services Cloud Control API User Guide.
	//
	// Identifier is a required field
	Identifier *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role for Cloud Control API to use when performing this resource operation.
	// The role specified must have the permissions required for this operation.
	// The necessary permissions for each event handler are defined in the handlers
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers)
	// section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html).
	//
	// If you do not specify a role, Cloud Control API uses a temporary session
	// created using your Amazon Web Services user credentials.
	//
	// For more information, see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions)
	// in the Amazon Web Services Cloud Control API User Guide.
	RoleArn *string `min:"20" type:"string"`

	// The name of the resource type.
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`

	// For private resource types, the type version to use in this resource operation.
	// If you do not specify a resource version, CloudFormation uses the default
	// version.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteResourceInput) GoString 

func (s DeleteResourceInput) 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 (*DeleteResourceInput) SetClientToken 

func (s *DeleteResourceInput) SetClientToken(v string) *DeleteResourceInput

SetClientToken sets the ClientToken field's value.

func (*DeleteResourceInput) SetIdentifier 

func (s *DeleteResourceInput) SetIdentifier(v string) *DeleteResourceInput

SetIdentifier sets the Identifier field's value.

func (*DeleteResourceInput) SetRoleArn 

func (s *DeleteResourceInput) SetRoleArn(v string) *DeleteResourceInput

SetRoleArn sets the RoleArn field's value.

func (*DeleteResourceInput) SetTypeName 

func (s *DeleteResourceInput) SetTypeName(v string) *DeleteResourceInput

SetTypeName sets the TypeName field's value.

func (*DeleteResourceInput) SetTypeVersionId 

func (s *DeleteResourceInput) SetTypeVersionId(v string) *DeleteResourceInput

SetTypeVersionId sets the TypeVersionId field's value.

func (DeleteResourceInput) String 

func (s DeleteResourceInput) 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 (*DeleteResourceInput) Validate 

func (s *DeleteResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteResourceOutput 

type DeleteResourceOutput struct {

	// Represents the current status of the resource deletion request.
	//
	// After you have initiated a resource deletion request, you can monitor the
	// progress of your request by calling GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html)
	// using the RequestToken of the ProgressEvent returned by DeleteResource.
	ProgressEvent *ProgressEvent `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteResourceOutput) GoString 

func (s DeleteResourceOutput) 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 (*DeleteResourceOutput) SetProgressEvent 

func (s *DeleteResourceOutput) SetProgressEvent(v *ProgressEvent) *DeleteResourceOutput

SetProgressEvent sets the ProgressEvent field's value.

func (DeleteResourceOutput) String 

func (s DeleteResourceOutput) 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 GeneralServiceException 

type GeneralServiceException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *GeneralServiceException) Code() string

Code returns the exception type name.

func (*GeneralServiceException) Error 

func (s *GeneralServiceException) Error() string

func (GeneralServiceException) GoString 

func (s GeneralServiceException) 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 (*GeneralServiceException) Message 

func (s *GeneralServiceException) Message() string

Message returns the exception's message.

func (*GeneralServiceException) OrigErr 

func (s *GeneralServiceException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*GeneralServiceException) RequestID 

func (s *GeneralServiceException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*GeneralServiceException) StatusCode 

func (s *GeneralServiceException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (GeneralServiceException) String 

func (s GeneralServiceException) 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 GetResourceInput 

type GetResourceInput struct {

	// The identifier for the resource.
	//
	// You can specify the primary identifier, or any secondary identifier defined
	// for the resource type in its resource schema. You can only specify one identifier.
	// Primary identifiers can be specified as a string or JSON; secondary identifiers
	// must be specified as JSON.
	//
	// For compound primary identifiers (that is, one that consists of multiple
	// resource properties strung together), to specify the primary identifier as
	// a string, list the property values in the order they are specified in the
	// primary identifier definition, separated by |.
	//
	// For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html)
	// in the Amazon Web Services Cloud Control API User Guide.
	//
	// Identifier is a required field
	Identifier *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role for Cloud Control API to use when performing this resource operation.
	// The role specified must have the permissions required for this operation.
	// The necessary permissions for each event handler are defined in the handlers
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers)
	// section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html).
	//
	// If you do not specify a role, Cloud Control API uses a temporary session
	// created using your Amazon Web Services user credentials.
	//
	// For more information, see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions)
	// in the Amazon Web Services Cloud Control API User Guide.
	RoleArn *string `min:"20" type:"string"`

	// The name of the resource type.
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`

	// For private resource types, the type version to use in this resource operation.
	// If you do not specify a resource version, CloudFormation uses the default
	// version.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetResourceInput) GoString 

func (s GetResourceInput) 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 (*GetResourceInput) SetIdentifier 

func (s *GetResourceInput) SetIdentifier(v string) *GetResourceInput

SetIdentifier sets the Identifier field's value.

func (*GetResourceInput) SetRoleArn 

func (s *GetResourceInput) SetRoleArn(v string) *GetResourceInput

SetRoleArn sets the RoleArn field's value.

func (*GetResourceInput) SetTypeName 

func (s *GetResourceInput) SetTypeName(v string) *GetResourceInput

SetTypeName sets the TypeName field's value.

func (*GetResourceInput) SetTypeVersionId 

func (s *GetResourceInput) SetTypeVersionId(v string) *GetResourceInput

SetTypeVersionId sets the TypeVersionId field's value.

func (GetResourceInput) String 

func (s GetResourceInput) 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 (*GetResourceInput) Validate 

func (s *GetResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetResourceOutput 

type GetResourceOutput struct {

	// Represents information about a provisioned resource.
	ResourceDescription *ResourceDescription `type:"structure"`

	// The name of the resource type.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (GetResourceOutput) GoString 

func (s GetResourceOutput) 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 (*GetResourceOutput) SetResourceDescription 

func (s *GetResourceOutput) SetResourceDescription(v *ResourceDescription) *GetResourceOutput

SetResourceDescription sets the ResourceDescription field's value.

func (*GetResourceOutput) SetTypeName 

func (s *GetResourceOutput) SetTypeName(v string) *GetResourceOutput

SetTypeName sets the TypeName field's value.

func (GetResourceOutput) String 

func (s GetResourceOutput) 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 GetResourceRequestStatusInput 

type GetResourceRequestStatusInput struct {

	// A unique token used to track the progress of the resource operation request.
	//
	// Request tokens are included in the ProgressEvent type returned by a resource
	// operation request.
	//
	// RequestToken is a required field
	RequestToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetResourceRequestStatusInput) GoString 

func (s GetResourceRequestStatusInput) 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 (*GetResourceRequestStatusInput) SetRequestToken 

func (s *GetResourceRequestStatusInput) SetRequestToken(v string) *GetResourceRequestStatusInput

SetRequestToken sets the RequestToken field's value.

func (GetResourceRequestStatusInput) String 

func (s GetResourceRequestStatusInput) 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 (*GetResourceRequestStatusInput) Validate 

func (s *GetResourceRequestStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetResourceRequestStatusOutput 

type GetResourceRequestStatusOutput struct {

	// Represents the current status of the resource operation request.
	ProgressEvent *ProgressEvent `type:"structure"`
	// contains filtered or unexported fields
}

func (GetResourceRequestStatusOutput) GoString 

func (s GetResourceRequestStatusOutput) 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 (*GetResourceRequestStatusOutput) SetProgressEvent 

func (s *GetResourceRequestStatusOutput) SetProgressEvent(v *ProgressEvent) *GetResourceRequestStatusOutput

SetProgressEvent sets the ProgressEvent field's value.

func (GetResourceRequestStatusOutput) String 

func (s GetResourceRequestStatusOutput) 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 HandlerFailureException 

type HandlerFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *HandlerFailureException) Code() string

Code returns the exception type name.

func (*HandlerFailureException) Error 

func (s *HandlerFailureException) Error() string

func (HandlerFailureException) GoString 

func (s HandlerFailureException) 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 (*HandlerFailureException) Message 

func (s *HandlerFailureException) Message() string

Message returns the exception's message.

func (*HandlerFailureException) OrigErr 

func (s *HandlerFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*HandlerFailureException) RequestID 

func (s *HandlerFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*HandlerFailureException) StatusCode 

func (s *HandlerFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (HandlerFailureException) String 

func (s HandlerFailureException) 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 HandlerInternalFailureException 

type HandlerInternalFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*HandlerInternalFailureException) Code 

func (s *HandlerInternalFailureException) Code() string

Code returns the exception type name.

func (*HandlerInternalFailureException) Error 

func (s *HandlerInternalFailureException) Error() string

func (HandlerInternalFailureException) GoString 

func (s HandlerInternalFailureException) 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 (*HandlerInternalFailureException) Message 

func (s *HandlerInternalFailureException) Message() string

Message returns the exception's message.

func (*HandlerInternalFailureException) OrigErr 

func (s *HandlerInternalFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*HandlerInternalFailureException) RequestID 

func (s *HandlerInternalFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*HandlerInternalFailureException) StatusCode 

func (s *HandlerInternalFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (HandlerInternalFailureException) String 

func (s HandlerInternalFailureException) 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 InvalidCredentialsException 

type InvalidCredentialsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidCredentialsException) Code 

func (s *InvalidCredentialsException) Code() string

Code returns the exception type name.

func (*InvalidCredentialsException) Error 

func (s *InvalidCredentialsException) Error() string

func (InvalidCredentialsException) GoString 

func (s InvalidCredentialsException) 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 (*InvalidCredentialsException) Message 

func (s *InvalidCredentialsException) Message() string

Message returns the exception's message.

func (*InvalidCredentialsException) OrigErr 

func (s *InvalidCredentialsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCredentialsException) RequestID 

func (s *InvalidCredentialsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCredentialsException) StatusCode 

func (s *InvalidCredentialsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidCredentialsException) String 

func (s InvalidCredentialsException) 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 InvalidRequestException 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString 

func (s InvalidRequestException) 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 (*InvalidRequestException) Message 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String 

func (s InvalidRequestException) 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 ListResourceRequestsInput 

type ListResourceRequestsInput struct {

	// The maximum number of results to be returned with a single call. If the number
	// of available results exceeds this maximum, the response includes a NextToken
	// value that you can assign to the NextToken request parameter to get the next
	// set of results.
	//
	// The default is 20.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The filter criteria to apply to the requests returned.
	ResourceRequestStatusFilter *ResourceRequestStatusFilter `type:"structure"`
	// contains filtered or unexported fields
}

func (ListResourceRequestsInput) GoString 

func (s ListResourceRequestsInput) 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 (*ListResourceRequestsInput) SetMaxResults 

func (s *ListResourceRequestsInput) SetMaxResults(v int64) *ListResourceRequestsInput

SetMaxResults sets the MaxResults field's value.

func (*ListResourceRequestsInput) SetNextToken 

func (s *ListResourceRequestsInput) SetNextToken(v string) *ListResourceRequestsInput

SetNextToken sets the NextToken field's value.

func (*ListResourceRequestsInput) SetResourceRequestStatusFilter 

func (s *ListResourceRequestsInput) SetResourceRequestStatusFilter(v *ResourceRequestStatusFilter) *ListResourceRequestsInput

SetResourceRequestStatusFilter sets the ResourceRequestStatusFilter field's value.

func (ListResourceRequestsInput) String 

func (s ListResourceRequestsInput) 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 (*ListResourceRequestsInput) Validate 

func (s *ListResourceRequestsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourceRequestsOutput 

type ListResourceRequestsOutput struct {

	// If the request doesn't return all of the remaining results, NextToken is
	// set to a token. To retrieve the next set of results, call ListResources again
	// and assign that token to the request object's NextToken parameter. If the
	// request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// The requests that match the specified filter criteria.
	ResourceRequestStatusSummaries []*ProgressEvent `type:"list"`
	// contains filtered or unexported fields
}

func (ListResourceRequestsOutput) GoString 

func (s ListResourceRequestsOutput) 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 (*ListResourceRequestsOutput) SetNextToken 

func (s *ListResourceRequestsOutput) SetNextToken(v string) *ListResourceRequestsOutput

SetNextToken sets the NextToken field's value.

func (*ListResourceRequestsOutput) SetResourceRequestStatusSummaries 

func (s *ListResourceRequestsOutput) SetResourceRequestStatusSummaries(v []*ProgressEvent) *ListResourceRequestsOutput

SetResourceRequestStatusSummaries sets the ResourceRequestStatusSummaries field's value.

func (ListResourceRequestsOutput) String 

func (s ListResourceRequestsOutput) 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 ListResourcesInput 

type ListResourcesInput struct {

	// Reserved.
	MaxResults *int64 `min:"1" type:"integer"`

	// If the previous paginated request didn't return all of the remaining results,
	// the response object's NextToken parameter value is set to a token. To retrieve
	// the next set of results, call this action again and assign that token to
	// the request object's NextToken parameter. If there are no remaining results,
	// the previous response object's NextToken parameter is set to null.
	NextToken *string `min:"1" type:"string"`

	// The resource model to use to select the resources to return.
	//
	// ResourceModel is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListResourcesInput's
	// String and GoString methods.
	ResourceModel *string `min:"1" type:"string" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role for Cloud Control API to use when performing this resource operation.
	// The role specified must have the permissions required for this operation.
	// The necessary permissions for each event handler are defined in the handlers
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers)
	// section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html).
	//
	// If you do not specify a role, Cloud Control API uses a temporary session
	// created using your Amazon Web Services user credentials.
	//
	// For more information, see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions)
	// in the Amazon Web Services Cloud Control API User Guide.
	RoleArn *string `min:"20" type:"string"`

	// The name of the resource type.
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`

	// For private resource types, the type version to use in this resource operation.
	// If you do not specify a resource version, CloudFormation uses the default
	// version.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListResourcesInput) GoString 

func (s ListResourcesInput) 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 (*ListResourcesInput) SetMaxResults 

func (s *ListResourcesInput) SetMaxResults(v int64) *ListResourcesInput

SetMaxResults sets the MaxResults field's value.

func (*ListResourcesInput) SetNextToken 

func (s *ListResourcesInput) SetNextToken(v string) *ListResourcesInput

SetNextToken sets the NextToken field's value.

func (*ListResourcesInput) SetResourceModel 

func (s *ListResourcesInput) SetResourceModel(v string) *ListResourcesInput

SetResourceModel sets the ResourceModel field's value.

func (*ListResourcesInput) SetRoleArn 

func (s *ListResourcesInput) SetRoleArn(v string) *ListResourcesInput

SetRoleArn sets the RoleArn field's value.

func (*ListResourcesInput) SetTypeName 

func (s *ListResourcesInput) SetTypeName(v string) *ListResourcesInput

SetTypeName sets the TypeName field's value.

func (*ListResourcesInput) SetTypeVersionId 

func (s *ListResourcesInput) SetTypeVersionId(v string) *ListResourcesInput

SetTypeVersionId sets the TypeVersionId field's value.

func (ListResourcesInput) String 

func (s ListResourcesInput) 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 (*ListResourcesInput) Validate 

func (s *ListResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourcesOutput 

type ListResourcesOutput struct {

	// If the request doesn't return all of the remaining results, NextToken is
	// set to a token. To retrieve the next set of results, call ListResources again
	// and assign that token to the request object's NextToken parameter. If the
	// request returns all results, NextToken is set to null.
	NextToken *string `min:"1" type:"string"`

	// Information about the specified resources, including primary identifier and
	// resource model.
	ResourceDescriptions []*ResourceDescription `type:"list"`

	// The name of the resource type.
	TypeName *string `min:"10" type:"string"`
	// contains filtered or unexported fields
}

func (ListResourcesOutput) GoString 

func (s ListResourcesOutput) 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 (*ListResourcesOutput) SetNextToken 

func (s *ListResourcesOutput) SetNextToken(v string) *ListResourcesOutput

SetNextToken sets the NextToken field's value.

func (*ListResourcesOutput) SetResourceDescriptions 

func (s *ListResourcesOutput) SetResourceDescriptions(v []*ResourceDescription) *ListResourcesOutput

SetResourceDescriptions sets the ResourceDescriptions field's value.

func (*ListResourcesOutput) SetTypeName 

func (s *ListResourcesOutput) SetTypeName(v string) *ListResourcesOutput

SetTypeName sets the TypeName field's value.

func (ListResourcesOutput) String 

func (s ListResourcesOutput) 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 NetworkFailureException 

type NetworkFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *NetworkFailureException) Code() string

Code returns the exception type name.

func (*NetworkFailureException) Error 

func (s *NetworkFailureException) Error() string

func (NetworkFailureException) GoString 

func (s NetworkFailureException) 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 (*NetworkFailureException) Message 

func (s *NetworkFailureException) Message() string

Message returns the exception's message.

func (*NetworkFailureException) OrigErr 

func (s *NetworkFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NetworkFailureException) RequestID 

func (s *NetworkFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NetworkFailureException) StatusCode 

func (s *NetworkFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NetworkFailureException) String 

func (s NetworkFailureException) 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 NotStabilizedException 

type NotStabilizedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *NotStabilizedException) Code() string

Code returns the exception type name.

func (*NotStabilizedException) Error 

func (s *NotStabilizedException) Error() string

func (NotStabilizedException) GoString 

func (s NotStabilizedException) 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 (*NotStabilizedException) Message 

func (s *NotStabilizedException) Message() string

Message returns the exception's message.

func (*NotStabilizedException) OrigErr 

func (s *NotStabilizedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotStabilizedException) RequestID 

func (s *NotStabilizedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotStabilizedException) StatusCode 

func (s *NotStabilizedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotStabilizedException) String 

func (s NotStabilizedException) 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 NotUpdatableException 

type NotUpdatableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *NotUpdatableException) Code() string

Code returns the exception type name.

func (*NotUpdatableException) Error 

func (s *NotUpdatableException) Error() string

func (NotUpdatableException) GoString 

func (s NotUpdatableException) 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 (*NotUpdatableException) Message 

func (s *NotUpdatableException) Message() string

Message returns the exception's message.

func (*NotUpdatableException) OrigErr 

func (s *NotUpdatableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotUpdatableException) RequestID 

func (s *NotUpdatableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotUpdatableException) StatusCode 

func (s *NotUpdatableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotUpdatableException) String 

func (s NotUpdatableException) 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 PrivateTypeException 

type PrivateTypeException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *PrivateTypeException) Code() string

Code returns the exception type name.

func (*PrivateTypeException) Error 

func (s *PrivateTypeException) Error() string

func (PrivateTypeException) GoString 

func (s PrivateTypeException) 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 (*PrivateTypeException) Message 

func (s *PrivateTypeException) Message() string

Message returns the exception's message.

func (*PrivateTypeException) OrigErr 

func (s *PrivateTypeException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*PrivateTypeException) RequestID 

func (s *PrivateTypeException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*PrivateTypeException) StatusCode 

func (s *PrivateTypeException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (PrivateTypeException) String 

func (s PrivateTypeException) 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 ProgressEvent 

type ProgressEvent struct {

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

	// When the resource operation request was initiated.
	EventTime *time.Time `type:"timestamp"`

	// 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 `min:"1" type:"string"`

	// The resource operation type.
	Operation *string `type:"string" enum:"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 *string `type:"string" enum:"OperationStatus"`

	// The unique token representing this resource operation request.
	//
	// Use the RequestToken with GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html)
	// to return the current status of a resource operation request.
	RequestToken *string `min:"1" type:"string"`

	// A JSON string containing the resource model, consisting of each resource
	// property and its current value.
	//
	// ResourceModel is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ProgressEvent's
	// String and GoString methods.
	ResourceModel *string `min:"1" type:"string" sensitive:"true"`

	// When to next request the status of this resource operation request.
	RetryAfter *time.Time `type:"timestamp"`

	// Any message explaining the current status.
	StatusMessage *string `type:"string"`

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

Represents the current status of a resource operation request. For more information, see Managing resource operation requests (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html) in the Amazon Web Services Cloud Control API User Guide.

func (ProgressEvent) GoString 

func (s ProgressEvent) 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 (*ProgressEvent) SetErrorCode 

func (s *ProgressEvent) SetErrorCode(v string) *ProgressEvent

SetErrorCode sets the ErrorCode field's value.

func (*ProgressEvent) SetEventTime 

func (s *ProgressEvent) SetEventTime(v time.Time) *ProgressEvent

SetEventTime sets the EventTime field's value.

func (*ProgressEvent) SetIdentifier 

func (s *ProgressEvent) SetIdentifier(v string) *ProgressEvent

SetIdentifier sets the Identifier field's value.

func (*ProgressEvent) SetOperation 

func (s *ProgressEvent) SetOperation(v string) *ProgressEvent

SetOperation sets the Operation field's value.

func (*ProgressEvent) SetOperationStatus 

func (s *ProgressEvent) SetOperationStatus(v string) *ProgressEvent

SetOperationStatus sets the OperationStatus field's value.

func (*ProgressEvent) SetRequestToken 

func (s *ProgressEvent) SetRequestToken(v string) *ProgressEvent

SetRequestToken sets the RequestToken field's value.

func (*ProgressEvent) SetResourceModel 

func (s *ProgressEvent) SetResourceModel(v string) *ProgressEvent

SetResourceModel sets the ResourceModel field's value.

func (*ProgressEvent) SetRetryAfter 

func (s *ProgressEvent) SetRetryAfter(v time.Time) *ProgressEvent

SetRetryAfter sets the RetryAfter field's value.

func (*ProgressEvent) SetStatusMessage 

func (s *ProgressEvent) SetStatusMessage(v string) *ProgressEvent

SetStatusMessage sets the StatusMessage field's value.

func (*ProgressEvent) SetTypeName 

func (s *ProgressEvent) SetTypeName(v string) *ProgressEvent

SetTypeName sets the TypeName field's value.

func (ProgressEvent) String 

func (s ProgressEvent) 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 RequestTokenNotFoundException 

type RequestTokenNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*RequestTokenNotFoundException) Code 

func (s *RequestTokenNotFoundException) Code() string

Code returns the exception type name.

func (*RequestTokenNotFoundException) Error 

func (s *RequestTokenNotFoundException) Error() string

func (RequestTokenNotFoundException) GoString 

func (s RequestTokenNotFoundException) 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 (*RequestTokenNotFoundException) Message 

func (s *RequestTokenNotFoundException) Message() string

Message returns the exception's message.

func (*RequestTokenNotFoundException) OrigErr 

func (s *RequestTokenNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestTokenNotFoundException) RequestID 

func (s *RequestTokenNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestTokenNotFoundException) StatusCode 

func (s *RequestTokenNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestTokenNotFoundException) String 

func (s RequestTokenNotFoundException) 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 ResourceConflictException 

type ResourceConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *ResourceConflictException) Code() string

Code returns the exception type name.

func (*ResourceConflictException) Error 

func (s *ResourceConflictException) Error() string

func (ResourceConflictException) GoString 

func (s ResourceConflictException) 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 (*ResourceConflictException) Message 

func (s *ResourceConflictException) Message() string

Message returns the exception's message.

func (*ResourceConflictException) OrigErr 

func (s *ResourceConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceConflictException) RequestID 

func (s *ResourceConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceConflictException) StatusCode 

func (s *ResourceConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceConflictException) String 

func (s ResourceConflictException) 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 ResourceDescription 

type ResourceDescription struct {

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

	// A list of the resource properties and their current values.
	//
	// Properties is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ResourceDescription's
	// String and GoString methods.
	Properties *string `min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

Represents information about a provisioned resource.

func (ResourceDescription) GoString 

func (s ResourceDescription) 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 (*ResourceDescription) SetIdentifier 

func (s *ResourceDescription) SetIdentifier(v string) *ResourceDescription

SetIdentifier sets the Identifier field's value.

func (*ResourceDescription) SetProperties 

func (s *ResourceDescription) SetProperties(v string) *ResourceDescription

SetProperties sets the Properties field's value.

func (ResourceDescription) String 

func (s ResourceDescription) 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" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

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 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 []*string `type:"list" enum:"OperationStatus"`

	// The operation types to include in the filter.
	Operations []*string `type:"list" enum:"Operation"`
	// contains filtered or unexported fields
}

The filter criteria to use in determining the requests returned.

func (ResourceRequestStatusFilter) GoString 

func (s ResourceRequestStatusFilter) 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 (*ResourceRequestStatusFilter) SetOperationStatuses 

func (s *ResourceRequestStatusFilter) SetOperationStatuses(v []*string) *ResourceRequestStatusFilter

SetOperationStatuses sets the OperationStatuses field's value.

func (*ResourceRequestStatusFilter) SetOperations 

func (s *ResourceRequestStatusFilter) SetOperations(v []*string) *ResourceRequestStatusFilter

SetOperations sets the Operations field's value.

func (ResourceRequestStatusFilter) String 

func (s ResourceRequestStatusFilter) 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 ServiceInternalErrorException 

type ServiceInternalErrorException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *ServiceInternalErrorException) Code() string

Code returns the exception type name.

func (*ServiceInternalErrorException) Error 

func (s *ServiceInternalErrorException) Error() string

func (ServiceInternalErrorException) GoString 

func (s ServiceInternalErrorException) 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 (*ServiceInternalErrorException) Message 

func (s *ServiceInternalErrorException) Message() string

Message returns the exception's message.

func (*ServiceInternalErrorException) OrigErr 

func (s *ServiceInternalErrorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceInternalErrorException) RequestID 

func (s *ServiceInternalErrorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceInternalErrorException) StatusCode 

func (s *ServiceInternalErrorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceInternalErrorException) String 

func (s ServiceInternalErrorException) 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 ServiceLimitExceededException 

type ServiceLimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"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) Code 

func (s *ServiceLimitExceededException) Code() string

Code returns the exception type name.

func (*ServiceLimitExceededException) Error 

func (s *ServiceLimitExceededException) Error() string

func (ServiceLimitExceededException) GoString 

func (s ServiceLimitExceededException) 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 (*ServiceLimitExceededException) Message 

func (s *ServiceLimitExceededException) Message() string

Message returns the exception's message.

func (*ServiceLimitExceededException) OrigErr 

func (s *ServiceLimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceLimitExceededException) RequestID 

func (s *ServiceLimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceLimitExceededException) StatusCode 

func (s *ServiceLimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceLimitExceededException) String 

func (s ServiceLimitExceededException) 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" min:"1" 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 TypeNotFoundException 

type TypeNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (*TypeNotFoundException) Code 

func (s *TypeNotFoundException) Code() string

Code returns the exception type name.

func (*TypeNotFoundException) Error 

func (s *TypeNotFoundException) Error() string

func (TypeNotFoundException) GoString 

func (s TypeNotFoundException) 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 (*TypeNotFoundException) Message 

func (s *TypeNotFoundException) Message() string

Message returns the exception's message.

func (*TypeNotFoundException) OrigErr 

func (s *TypeNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TypeNotFoundException) RequestID 

func (s *TypeNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TypeNotFoundException) StatusCode 

func (s *TypeNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TypeNotFoundException) String 

func (s TypeNotFoundException) 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 UnsupportedActionException 

type UnsupportedActionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified resource doesn't support this resource operation.

func (*UnsupportedActionException) Code 

func (s *UnsupportedActionException) Code() string

Code returns the exception type name.

func (*UnsupportedActionException) Error 

func (s *UnsupportedActionException) Error() string

func (UnsupportedActionException) GoString 

func (s UnsupportedActionException) 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 (*UnsupportedActionException) Message 

func (s *UnsupportedActionException) Message() string

Message returns the exception's message.

func (*UnsupportedActionException) OrigErr 

func (s *UnsupportedActionException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedActionException) RequestID 

func (s *UnsupportedActionException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedActionException) StatusCode 

func (s *UnsupportedActionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedActionException) String 

func (s UnsupportedActionException) 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 UpdateResourceInput 

type UpdateResourceInput struct {

	// A unique identifier to ensure the idempotency of the resource request. As
	// a best practice, specify this token to ensure idempotency, so that Amazon
	// Web Services Cloud Control API can accurately distinguish between request
	// retries and new resource requests. You might retry a resource request to
	// ensure that it was successfully received.
	//
	// A client token is valid for 36 hours once used. After that, a resource request
	// with the same client token is treated as a new request.
	//
	// If you do not specify a client token, one is generated for inclusion in the
	// request.
	//
	// For more information, see Ensuring resource operation requests are unique
	// (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-idempotency)
	// in the Amazon Web Services Cloud Control API User Guide.
	ClientToken *string `min:"1" type:"string" idempotencyToken:"true"`

	// The identifier for the resource.
	//
	// You can specify the primary identifier, or any secondary identifier defined
	// for the resource type in its resource schema. You can only specify one identifier.
	// Primary identifiers can be specified as a string or JSON; secondary identifiers
	// must be specified as JSON.
	//
	// For compound primary identifiers (that is, one that consists of multiple
	// resource properties strung together), to specify the primary identifier as
	// a string, list the property values in the order they are specified in the
	// primary identifier definition, separated by |.
	//
	// For more information, see Identifying resources (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-identifier.html)
	// in the Amazon Web Services Cloud Control API User Guide.
	//
	// Identifier is a required field
	Identifier *string `min:"1" type:"string" required:"true"`

	// A JavaScript Object Notation (JSON) document listing the patch operations
	// that represent the updates to apply to the current resource properties. For
	// details, see Composing the patch document (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html#resource-operations-update-patch)
	// in the Amazon Web Services Cloud Control API User Guide.
	//
	// PatchDocument is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateResourceInput's
	// String and GoString methods.
	//
	// PatchDocument is a required field
	PatchDocument *string `min:"1" type:"string" required:"true" sensitive:"true"`

	// The Amazon Resource Name (ARN) of the Identity and Access Management (IAM)
	// role for Cloud Control API to use when performing this resource operation.
	// The role specified must have the permissions required for this operation.
	// The necessary permissions for each event handler are defined in the handlers
	// (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers)
	// section of the resource type definition schema (https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html).
	//
	// If you do not specify a role, Cloud Control API uses a temporary session
	// created using your Amazon Web Services user credentials.
	//
	// For more information, see Specifying credentials (https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions)
	// in the Amazon Web Services Cloud Control API User Guide.
	RoleArn *string `min:"20" type:"string"`

	// The name of the resource type.
	//
	// TypeName is a required field
	TypeName *string `min:"10" type:"string" required:"true"`

	// For private resource types, the type version to use in this resource operation.
	// If you do not specify a resource version, CloudFormation uses the default
	// version.
	TypeVersionId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateResourceInput) GoString 

func (s UpdateResourceInput) 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 (*UpdateResourceInput) SetClientToken 

func (s *UpdateResourceInput) SetClientToken(v string) *UpdateResourceInput

SetClientToken sets the ClientToken field's value.

func (*UpdateResourceInput) SetIdentifier 

func (s *UpdateResourceInput) SetIdentifier(v string) *UpdateResourceInput

SetIdentifier sets the Identifier field's value.

func (*UpdateResourceInput) SetPatchDocument 

func (s *UpdateResourceInput) SetPatchDocument(v string) *UpdateResourceInput

SetPatchDocument sets the PatchDocument field's value.

func (*UpdateResourceInput) SetRoleArn 

func (s *UpdateResourceInput) SetRoleArn(v string) *UpdateResourceInput

SetRoleArn sets the RoleArn field's value.

func (*UpdateResourceInput) SetTypeName 

func (s *UpdateResourceInput) SetTypeName(v string) *UpdateResourceInput

SetTypeName sets the TypeName field's value.

func (*UpdateResourceInput) SetTypeVersionId 

func (s *UpdateResourceInput) SetTypeVersionId(v string) *UpdateResourceInput

SetTypeVersionId sets the TypeVersionId field's value.

func (UpdateResourceInput) String 

func (s UpdateResourceInput) 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 (*UpdateResourceInput) Validate 

func (s *UpdateResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateResourceOutput 

type UpdateResourceOutput struct {

	// Represents the current status of the resource update request.
	//
	// Use the RequestToken of the ProgressEvent with GetResourceRequestStatus (https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html)
	// to return the current status of a resource operation request.
	ProgressEvent *ProgressEvent `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateResourceOutput) GoString 

func (s UpdateResourceOutput) 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 (*UpdateResourceOutput) SetProgressEvent 

func (s *UpdateResourceOutput) SetProgressEvent(v *ProgressEvent) *UpdateResourceOutput

SetProgressEvent sets the ProgressEvent field's value.

func (UpdateResourceOutput) String 

func (s UpdateResourceOutput) 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".

Source Files

View all Source files

Directories

Path Synopsis
Package cloudcontrolapiiface provides an interface to enable mocking the AWS Cloud Control API service client for testing your code.
 Package cloudcontrolapiiface provides an interface to enable mocking the AWS Cloud Control API service client for testing your code.

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.