func HandlerErrorCode_Values() []string
HandlerErrorCode_Values returns all elements of the HandlerErrorCode enum
func OperationStatus_Values() []string
OperationStatus_Values returns all elements of the OperationStatus enum
func Operation_Values() []string
Operation_Values returns all elements of the Operation enum
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 (s *AlreadyExistsException) Code() string
Code returns the exception type name.
func (s *AlreadyExistsException) Error() string
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 (s *AlreadyExistsException) Message() string
Message returns the exception's message.
func (s *AlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *CancelResourceRequestInput) SetRequestToken(v string) *CancelResourceRequestInput
SetRequestToken sets the RequestToken field's value.
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 (s *CancelResourceRequestInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CancelResourceRequestOutput) SetProgressEvent(v *ProgressEvent) *CancelResourceRequestOutput
SetProgressEvent sets the ProgressEvent field's value.
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 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 (s *ClientTokenConflictException) Code() string
Code returns the exception type name.
func (s *ClientTokenConflictException) Error() string
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 (s *ClientTokenConflictException) Message() string
Message returns the exception's message.
func (s *ClientTokenConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ClientTokenConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ClientTokenConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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:
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudcontrol-2021-09-30/GetResourceRequestStatus
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (s *ConcurrentModificationException) Code() string
Code returns the exception type name.
func (s *ConcurrentModificationException) Error() string
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 (s *ConcurrentModificationException) Message() string
Message returns the exception's message.
func (s *ConcurrentModificationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConcurrentModificationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConcurrentModificationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ConcurrentOperationException) Code() string
Code returns the exception type name.
func (s *ConcurrentOperationException) Error() string
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 (s *ConcurrentOperationException) Message() string
Message returns the exception's message.
func (s *ConcurrentOperationException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConcurrentOperationException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConcurrentOperationException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *CreateResourceInput) SetClientToken(v string) *CreateResourceInput
SetClientToken sets the ClientToken field's value.
func (s *CreateResourceInput) SetDesiredState(v string) *CreateResourceInput
SetDesiredState sets the DesiredState field's value.
func (s *CreateResourceInput) SetRoleArn(v string) *CreateResourceInput
SetRoleArn sets the RoleArn field's value.
func (s *CreateResourceInput) SetTypeName(v string) *CreateResourceInput
SetTypeName sets the TypeName field's value.
func (s *CreateResourceInput) SetTypeVersionId(v string) *CreateResourceInput
SetTypeVersionId sets the TypeVersionId field's value.
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 (s *CreateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateResourceOutput) SetProgressEvent(v *ProgressEvent) *CreateResourceOutput
SetProgressEvent sets the ProgressEvent field's value.
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 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 (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 (s *DeleteResourceInput) SetClientToken(v string) *DeleteResourceInput
SetClientToken sets the ClientToken field's value.
func (s *DeleteResourceInput) SetIdentifier(v string) *DeleteResourceInput
SetIdentifier sets the Identifier field's value.
func (s *DeleteResourceInput) SetRoleArn(v string) *DeleteResourceInput
SetRoleArn sets the RoleArn field's value.
func (s *DeleteResourceInput) SetTypeName(v string) *DeleteResourceInput
SetTypeName sets the TypeName field's value.
func (s *DeleteResourceInput) SetTypeVersionId(v string) *DeleteResourceInput
SetTypeVersionId sets the TypeVersionId field's value.
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 (s *DeleteResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteResourceOutput) SetProgressEvent(v *ProgressEvent) *DeleteResourceOutput
SetProgressEvent sets the ProgressEvent field's value.
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 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 (s *GeneralServiceException) Code() string
Code returns the exception type name.
func (s *GeneralServiceException) Error() string
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 (s *GeneralServiceException) Message() string
Message returns the exception's message.
func (s *GeneralServiceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *GeneralServiceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *GeneralServiceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *GetResourceInput) SetIdentifier(v string) *GetResourceInput
SetIdentifier sets the Identifier field's value.
func (s *GetResourceInput) SetRoleArn(v string) *GetResourceInput
SetRoleArn sets the RoleArn field's value.
func (s *GetResourceInput) SetTypeName(v string) *GetResourceInput
SetTypeName sets the TypeName field's value.
func (s *GetResourceInput) SetTypeVersionId(v string) *GetResourceInput
SetTypeVersionId sets the TypeVersionId field's value.
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 (s *GetResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetResourceOutput) SetResourceDescription(v *ResourceDescription) *GetResourceOutput
SetResourceDescription sets the ResourceDescription field's value.
func (s *GetResourceOutput) SetTypeName(v string) *GetResourceOutput
SetTypeName sets the TypeName field's value.
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 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 (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 (s *GetResourceRequestStatusInput) SetRequestToken(v string) *GetResourceRequestStatusInput
SetRequestToken sets the RequestToken field's value.
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 (s *GetResourceRequestStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetResourceRequestStatusOutput struct {
// Represents the current status of the resource operation request.
ProgressEvent *ProgressEvent `type:"structure"`
// contains filtered or unexported fields
}
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 (s *GetResourceRequestStatusOutput) SetProgressEvent(v *ProgressEvent) *GetResourceRequestStatusOutput
SetProgressEvent sets the ProgressEvent field's value.
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 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 (s *HandlerFailureException) Code() string
Code returns the exception type name.
func (s *HandlerFailureException) Error() string
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 (s *HandlerFailureException) Message() string
Message returns the exception's message.
func (s *HandlerFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *HandlerFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *HandlerFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *HandlerInternalFailureException) Code() string
Code returns the exception type name.
func (s *HandlerInternalFailureException) Error() string
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 (s *HandlerInternalFailureException) Message() string
Message returns the exception's message.
func (s *HandlerInternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *HandlerInternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *HandlerInternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidCredentialsException) Code() string
Code returns the exception type name.
func (s *InvalidCredentialsException) Error() string
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 (s *InvalidCredentialsException) Message() string
Message returns the exception's message.
func (s *InvalidCredentialsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidCredentialsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidCredentialsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
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 (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ListResourceRequestsInput) SetMaxResults(v int64) *ListResourceRequestsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListResourceRequestsInput) SetNextToken(v string) *ListResourceRequestsInput
SetNextToken sets the NextToken field's value.
func (s *ListResourceRequestsInput) SetResourceRequestStatusFilter(v *ResourceRequestStatusFilter) *ListResourceRequestsInput
SetResourceRequestStatusFilter sets the ResourceRequestStatusFilter field's value.
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 (s *ListResourceRequestsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListResourceRequestsOutput) SetNextToken(v string) *ListResourceRequestsOutput
SetNextToken sets the NextToken field's value.
func (s *ListResourceRequestsOutput) SetResourceRequestStatusSummaries(v []*ProgressEvent) *ListResourceRequestsOutput
SetResourceRequestStatusSummaries sets the ResourceRequestStatusSummaries field's value.
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 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 (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 (s *ListResourcesInput) SetMaxResults(v int64) *ListResourcesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListResourcesInput) SetNextToken(v string) *ListResourcesInput
SetNextToken sets the NextToken field's value.
func (s *ListResourcesInput) SetResourceModel(v string) *ListResourcesInput
SetResourceModel sets the ResourceModel field's value.
func (s *ListResourcesInput) SetRoleArn(v string) *ListResourcesInput
SetRoleArn sets the RoleArn field's value.
func (s *ListResourcesInput) SetTypeName(v string) *ListResourcesInput
SetTypeName sets the TypeName field's value.
func (s *ListResourcesInput) SetTypeVersionId(v string) *ListResourcesInput
SetTypeVersionId sets the TypeVersionId field's value.
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 (s *ListResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListResourcesOutput) SetNextToken(v string) *ListResourcesOutput
SetNextToken sets the NextToken field's value.
func (s *ListResourcesOutput) SetResourceDescriptions(v []*ResourceDescription) *ListResourcesOutput
SetResourceDescriptions sets the ResourceDescriptions field's value.
func (s *ListResourcesOutput) SetTypeName(v string) *ListResourcesOutput
SetTypeName sets the TypeName field's value.
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 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 (s *NetworkFailureException) Code() string
Code returns the exception type name.
func (s *NetworkFailureException) Error() string
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 (s *NetworkFailureException) Message() string
Message returns the exception's message.
func (s *NetworkFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *NetworkFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *NetworkFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *NotStabilizedException) Code() string
Code returns the exception type name.
func (s *NotStabilizedException) Error() string
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 (s *NotStabilizedException) Message() string
Message returns the exception's message.
func (s *NotStabilizedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *NotStabilizedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *NotStabilizedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *NotUpdatableException) Code() string
Code returns the exception type name.
func (s *NotUpdatableException) Error() string
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 (s *NotUpdatableException) Message() string
Message returns the exception's message.
func (s *NotUpdatableException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *NotUpdatableException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *NotUpdatableException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *PrivateTypeException) Code() string
Code returns the exception type name.
func (s *PrivateTypeException) Error() string
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 (s *PrivateTypeException) Message() string
Message returns the exception's message.
func (s *PrivateTypeException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *PrivateTypeException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *PrivateTypeException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ProgressEvent) SetErrorCode(v string) *ProgressEvent
SetErrorCode sets the ErrorCode field's value.
func (s *ProgressEvent) SetEventTime(v time.Time) *ProgressEvent
SetEventTime sets the EventTime field's value.
func (s *ProgressEvent) SetIdentifier(v string) *ProgressEvent
SetIdentifier sets the Identifier field's value.
func (s *ProgressEvent) SetOperation(v string) *ProgressEvent
SetOperation sets the Operation field's value.
func (s *ProgressEvent) SetOperationStatus(v string) *ProgressEvent
SetOperationStatus sets the OperationStatus field's value.
func (s *ProgressEvent) SetRequestToken(v string) *ProgressEvent
SetRequestToken sets the RequestToken field's value.
func (s *ProgressEvent) SetResourceModel(v string) *ProgressEvent
SetResourceModel sets the ResourceModel field's value.
func (s *ProgressEvent) SetRetryAfter(v time.Time) *ProgressEvent
SetRetryAfter sets the RetryAfter field's value.
func (s *ProgressEvent) SetStatusMessage(v string) *ProgressEvent
SetStatusMessage sets the StatusMessage field's value.
func (s *ProgressEvent) SetTypeName(v string) *ProgressEvent
SetTypeName sets the TypeName field's value.
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 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 (s *RequestTokenNotFoundException) Code() string
Code returns the exception type name.
func (s *RequestTokenNotFoundException) Error() string
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 (s *RequestTokenNotFoundException) Message() string
Message returns the exception's message.
func (s *RequestTokenNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *RequestTokenNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *RequestTokenNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ResourceConflictException) Code() string
Code returns the exception type name.
func (s *ResourceConflictException) Error() string
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 (s *ResourceConflictException) Message() string
Message returns the exception's message.
func (s *ResourceConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ResourceDescription) SetIdentifier(v string) *ResourceDescription
SetIdentifier sets the Identifier field's value.
func (s *ResourceDescription) SetProperties(v string) *ResourceDescription
SetProperties sets the Properties field's value.
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 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 (s *ResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *ResourceNotFoundException) Error() string
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 (s *ResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *ResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ResourceRequestStatusFilter) SetOperationStatuses(v []*string) *ResourceRequestStatusFilter
SetOperationStatuses sets the OperationStatuses field's value.
func (s *ResourceRequestStatusFilter) SetOperations(v []*string) *ResourceRequestStatusFilter
SetOperations sets the Operations field's value.
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 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 (s *ServiceInternalErrorException) Code() string
Code returns the exception type name.
func (s *ServiceInternalErrorException) Error() string
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 (s *ServiceInternalErrorException) Message() string
Message returns the exception's message.
func (s *ServiceInternalErrorException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceInternalErrorException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceInternalErrorException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ServiceLimitExceededException) Code() string
Code returns the exception type name.
func (s *ServiceLimitExceededException) Error() string
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 (s *ServiceLimitExceededException) Message() string
Message returns the exception's message.
func (s *ServiceLimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ServiceLimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ServiceLimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *ThrottlingException) Code() string
Code returns the exception type name.
func (s *ThrottlingException) Error() string
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 (s *ThrottlingException) Message() string
Message returns the exception's message.
func (s *ThrottlingException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ThrottlingException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ThrottlingException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *TypeNotFoundException) Code() string
Code returns the exception type name.
func (s *TypeNotFoundException) Error() string
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 (s *TypeNotFoundException) Message() string
Message returns the exception's message.
func (s *TypeNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *TypeNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *TypeNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *UnsupportedActionException) Code() string
Code returns the exception type name.
func (s *UnsupportedActionException) Error() string
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 (s *UnsupportedActionException) Message() string
Message returns the exception's message.
func (s *UnsupportedActionException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *UnsupportedActionException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *UnsupportedActionException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *UpdateResourceInput) SetClientToken(v string) *UpdateResourceInput
SetClientToken sets the ClientToken field's value.
func (s *UpdateResourceInput) SetIdentifier(v string) *UpdateResourceInput
SetIdentifier sets the Identifier field's value.
func (s *UpdateResourceInput) SetPatchDocument(v string) *UpdateResourceInput
SetPatchDocument sets the PatchDocument field's value.
func (s *UpdateResourceInput) SetRoleArn(v string) *UpdateResourceInput
SetRoleArn sets the RoleArn field's value.
func (s *UpdateResourceInput) SetTypeName(v string) *UpdateResourceInput
SetTypeName sets the TypeName field's value.
func (s *UpdateResourceInput) SetTypeVersionId(v string) *UpdateResourceInput
SetTypeVersionId sets the TypeVersionId field's value.
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 (s *UpdateResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *UpdateResourceOutput) SetProgressEvent(v *ProgressEvent) *UpdateResourceOutput
SetProgressEvent sets the ProgressEvent field's value.
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".