Table of Contents
CloudControlApi.Client¶A low-level client representing AWS Cloud Control API (CloudControlApi)
For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.
import boto3
client = boto3.client('cloudcontrol')
These are the available methods:
can_paginate()cancel_resource_request()close()create_resource()delete_resource()get_paginator()get_resource()get_resource_request_status()get_waiter()list_resource_requests()list_resources()update_resource()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_resource_request(**kwargs)¶Cancels the specified resource operation request. For more information, see Canceling resource operation requests 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.
See also: AWS API Documentation
Request Syntax
response = client.cancel_resource_request(
RequestToken='string'
)
[REQUIRED]
The RequestToken of the ProgressEvent object returned by the resource operation request.
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide .
The name of the resource type used in the operation.
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
The resource operation type.
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.When the resource operation request was initiated.
A JSON string containing the resource model, consisting of each resource property and its current value.
Any message explaining the current status.
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
When to next request the status of this resource operation request.
Exceptions
CloudControlApi.Client.exceptions.ConcurrentModificationExceptionCloudControlApi.Client.exceptions.RequestTokenNotFoundExceptionclose()¶Closes underlying endpoint connections.
create_resource(**kwargs)¶Creates the specified resource. For more information, see Creating a resource 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 using the RequestToken of the ProgressEvent type returned by CreateResource .
See also: AWS API Documentation
Request Syntax
response = client.create_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
DesiredState='string'
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
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 in the Amazon Web Services Cloud Control API User Guide .
This field is autopopulated if not provided.
[REQUIRED]
Structured data format representing the desired state of the resource, consisting of that resource's properties and their desired values.
Note
Cloud Control API currently supports JSON as a structured data format.
<p>Specify the desired state as one of the following:</p> <ul> <li> <p>A JSON blob</p> </li> <li> <p>A local path containing the desired state in JSON data format</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html#resource-operations-create-desiredstate">Composing the desired state of the resource</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p> <p>For more information about the properties of a specific resource, refer to the related topic for the resource in the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Resource and property types reference</a> in the <i>CloudFormation Users Guide</i>.</p>
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
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 using the RequestToken of the ProgressEvent returned by CreateResource .
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
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.EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
RetryAfter (datetime) --
When to next request the status of this resource operation request.
Exceptions
CloudControlApi.Client.exceptions.AlreadyExistsExceptionCloudControlApi.Client.exceptions.HandlerInternalFailureExceptionCloudControlApi.Client.exceptions.GeneralServiceExceptionCloudControlApi.Client.exceptions.NotUpdatableExceptionCloudControlApi.Client.exceptions.TypeNotFoundExceptionCloudControlApi.Client.exceptions.ConcurrentOperationExceptionCloudControlApi.Client.exceptions.InvalidRequestExceptionCloudControlApi.Client.exceptions.PrivateTypeExceptionCloudControlApi.Client.exceptions.ResourceNotFoundExceptionCloudControlApi.Client.exceptions.NetworkFailureExceptionCloudControlApi.Client.exceptions.UnsupportedActionExceptionCloudControlApi.Client.exceptions.NotStabilizedExceptionCloudControlApi.Client.exceptions.ServiceInternalErrorExceptionCloudControlApi.Client.exceptions.HandlerFailureExceptionCloudControlApi.Client.exceptions.ServiceLimitExceededExceptionCloudControlApi.Client.exceptions.InvalidCredentialsExceptionCloudControlApi.Client.exceptions.ResourceConflictExceptionCloudControlApi.Client.exceptions.ClientTokenConflictExceptionCloudControlApi.Client.exceptions.ThrottlingExceptiondelete_resource(**kwargs)¶Deletes the specified resource. For details, see Deleting a resource 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 using the RequestToken of the ProgressEvent returned by DeleteResource .
See also: AWS API Documentation
Request Syntax
response = client.delete_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
Identifier='string'
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
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 in the Amazon Web Services Cloud Control API User Guide .
This field is autopopulated if not provided.
[REQUIRED]
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 in the Amazon Web Services Cloud Control API User Guide .
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
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 using the RequestToken of the ProgressEvent returned by DeleteResource .
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
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.EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
RetryAfter (datetime) --
When to next request the status of this resource operation request.
Exceptions
CloudControlApi.Client.exceptions.AlreadyExistsExceptionCloudControlApi.Client.exceptions.HandlerInternalFailureExceptionCloudControlApi.Client.exceptions.GeneralServiceExceptionCloudControlApi.Client.exceptions.NotUpdatableExceptionCloudControlApi.Client.exceptions.TypeNotFoundExceptionCloudControlApi.Client.exceptions.ConcurrentOperationExceptionCloudControlApi.Client.exceptions.InvalidRequestExceptionCloudControlApi.Client.exceptions.PrivateTypeExceptionCloudControlApi.Client.exceptions.ResourceNotFoundExceptionCloudControlApi.Client.exceptions.NetworkFailureExceptionCloudControlApi.Client.exceptions.UnsupportedActionExceptionCloudControlApi.Client.exceptions.NotStabilizedExceptionCloudControlApi.Client.exceptions.ServiceInternalErrorExceptionCloudControlApi.Client.exceptions.HandlerFailureExceptionCloudControlApi.Client.exceptions.ServiceLimitExceededExceptionCloudControlApi.Client.exceptions.InvalidCredentialsExceptionCloudControlApi.Client.exceptions.ResourceConflictExceptionCloudControlApi.Client.exceptions.ClientTokenConflictExceptionCloudControlApi.Client.exceptions.ThrottlingExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_resource(**kwargs)¶Returns information about the current state of the specified resource. For details, see Reading a resource's current state.
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.
See also: AWS API Documentation
Request Syntax
response = client.get_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
Identifier='string'
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
[REQUIRED]
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 in the Amazon Web Services Cloud Control API User Guide .
dict
Response Syntax
{
'TypeName': 'string',
'ResourceDescription': {
'Identifier': 'string',
'Properties': 'string'
}
}
Response Structure
(dict) --
TypeName (string) --
The name of the resource type.
ResourceDescription (dict) --
Represents information about a provisioned resource.
Identifier (string) --
The primary identifier for the resource.
For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide .
Properties (string) --
A list of the resource properties and their current values.
Exceptions
CloudControlApi.Client.exceptions.AlreadyExistsExceptionCloudControlApi.Client.exceptions.HandlerInternalFailureExceptionCloudControlApi.Client.exceptions.GeneralServiceExceptionCloudControlApi.Client.exceptions.NotUpdatableExceptionCloudControlApi.Client.exceptions.TypeNotFoundExceptionCloudControlApi.Client.exceptions.InvalidRequestExceptionCloudControlApi.Client.exceptions.PrivateTypeExceptionCloudControlApi.Client.exceptions.ResourceNotFoundExceptionCloudControlApi.Client.exceptions.NetworkFailureExceptionCloudControlApi.Client.exceptions.UnsupportedActionExceptionCloudControlApi.Client.exceptions.NotStabilizedExceptionCloudControlApi.Client.exceptions.ServiceInternalErrorExceptionCloudControlApi.Client.exceptions.HandlerFailureExceptionCloudControlApi.Client.exceptions.ServiceLimitExceededExceptionCloudControlApi.Client.exceptions.InvalidCredentialsExceptionCloudControlApi.Client.exceptions.ResourceConflictExceptionCloudControlApi.Client.exceptions.ThrottlingExceptionget_resource_request_status(**kwargs)¶Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide .
See also: AWS API Documentation
Request Syntax
response = client.get_resource_request_status(
RequestToken='string'
)
[REQUIRED]
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.
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
Represents the current status of the resource operation request.
The name of the resource type used in the operation.
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
The resource operation type.
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.When the resource operation request was initiated.
A JSON string containing the resource model, consisting of each resource property and its current value.
Any message explaining the current status.
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
When to next request the status of this resource operation request.
Exceptions
CloudControlApi.Client.exceptions.RequestTokenNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_resource_requests(**kwargs)¶Returns existing resource operation requests. This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide .
Note
Resource operation requests expire after 7 days.
See also: AWS API Documentation
Request Syntax
response = client.list_resource_requests(
MaxResults=123,
NextToken='string',
ResourceRequestStatusFilter={
'Operations': [
'CREATE'|'DELETE'|'UPDATE',
],
'OperationStatuses': [
'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
]
}
)
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 .
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 .The filter criteria to apply to the requests returned.
The operation types to include in the filter.
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.dict
Response Syntax
{
'ResourceRequestStatusSummaries': [
{
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceRequestStatusSummaries (list) --
The requests that match the specified filter criteria.
(dict) --
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide .
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
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.EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
RetryAfter (datetime) --
When to next request the status of this resource operation request.
NextToken (string) --
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.
list_resources(**kwargs)¶Returns information about the specified resources. For more information, see Discovering resources 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.
See also: AWS API Documentation
Request Syntax
response = client.list_resources(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
NextToken='string',
MaxResults=123,
ResourceModel='string'
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
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 .dict
Response Syntax
{
'TypeName': 'string',
'ResourceDescriptions': [
{
'Identifier': 'string',
'Properties': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TypeName (string) --
The name of the resource type.
ResourceDescriptions (list) --
Information about the specified resources, including primary identifier and resource model.
(dict) --
Represents information about a provisioned resource.
Identifier (string) --
The primary identifier for the resource.
For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide .
Properties (string) --
A list of the resource properties and their current values.
NextToken (string) --
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.
Exceptions
CloudControlApi.Client.exceptions.AlreadyExistsExceptionCloudControlApi.Client.exceptions.HandlerInternalFailureExceptionCloudControlApi.Client.exceptions.GeneralServiceExceptionCloudControlApi.Client.exceptions.NotUpdatableExceptionCloudControlApi.Client.exceptions.TypeNotFoundExceptionCloudControlApi.Client.exceptions.InvalidRequestExceptionCloudControlApi.Client.exceptions.PrivateTypeExceptionCloudControlApi.Client.exceptions.ResourceNotFoundExceptionCloudControlApi.Client.exceptions.NetworkFailureExceptionCloudControlApi.Client.exceptions.UnsupportedActionExceptionCloudControlApi.Client.exceptions.NotStabilizedExceptionCloudControlApi.Client.exceptions.ServiceInternalErrorExceptionCloudControlApi.Client.exceptions.HandlerFailureExceptionCloudControlApi.Client.exceptions.ServiceLimitExceededExceptionCloudControlApi.Client.exceptions.InvalidCredentialsExceptionCloudControlApi.Client.exceptions.ResourceConflictExceptionCloudControlApi.Client.exceptions.ThrottlingExceptionupdate_resource(**kwargs)¶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 standard.
For details on how Cloud Control API performs resource update operations, see Updating a resource 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 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 in the CloudFormation Users Guide .
See also: AWS API Documentation
Request Syntax
response = client.update_resource(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ClientToken='string',
Identifier='string',
PatchDocument='string'
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
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 in the Amazon Web Services Cloud Control API User Guide .
This field is autopopulated if not provided.
[REQUIRED]
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 in the Amazon Web Services Cloud Control API User Guide .
[REQUIRED]
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 in the Amazon Web Services Cloud Control API User Guide .
dict
Response Syntax
{
'ProgressEvent': {
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ProgressEvent (dict) --
Represents the current status of the resource update request.
Use the RequestToken of the ProgressEvent with GetResourceRequestStatus to return the current status of a resource operation request.
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
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.EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
RetryAfter (datetime) --
When to next request the status of this resource operation request.
Exceptions
CloudControlApi.Client.exceptions.AlreadyExistsExceptionCloudControlApi.Client.exceptions.HandlerInternalFailureExceptionCloudControlApi.Client.exceptions.GeneralServiceExceptionCloudControlApi.Client.exceptions.NotUpdatableExceptionCloudControlApi.Client.exceptions.TypeNotFoundExceptionCloudControlApi.Client.exceptions.ConcurrentOperationExceptionCloudControlApi.Client.exceptions.InvalidRequestExceptionCloudControlApi.Client.exceptions.PrivateTypeExceptionCloudControlApi.Client.exceptions.ResourceNotFoundExceptionCloudControlApi.Client.exceptions.NetworkFailureExceptionCloudControlApi.Client.exceptions.UnsupportedActionExceptionCloudControlApi.Client.exceptions.NotStabilizedExceptionCloudControlApi.Client.exceptions.ServiceInternalErrorExceptionCloudControlApi.Client.exceptions.HandlerFailureExceptionCloudControlApi.Client.exceptions.ServiceLimitExceededExceptionCloudControlApi.Client.exceptions.InvalidCredentialsExceptionCloudControlApi.Client.exceptions.ResourceConflictExceptionCloudControlApi.Client.exceptions.ClientTokenConflictExceptionCloudControlApi.Client.exceptions.ThrottlingExceptionThe available paginators are:
CloudControlApi.Paginator.ListResourceRequests¶paginator = client.get_paginator('list_resource_requests')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudControlApi.Client.list_resource_requests().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceRequestStatusFilter={
'Operations': [
'CREATE'|'DELETE'|'UPDATE',
],
'OperationStatuses': [
'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The filter criteria to apply to the requests returned.
The operation types to include in the filter.
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.A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceRequestStatusSummaries': [
{
'TypeName': 'string',
'Identifier': 'string',
'RequestToken': 'string',
'Operation': 'CREATE'|'DELETE'|'UPDATE',
'OperationStatus': 'PENDING'|'IN_PROGRESS'|'SUCCESS'|'FAILED'|'CANCEL_IN_PROGRESS'|'CANCEL_COMPLETE',
'EventTime': datetime(2015, 1, 1),
'ResourceModel': 'string',
'StatusMessage': 'string',
'ErrorCode': 'NotUpdatable'|'InvalidRequest'|'AccessDenied'|'InvalidCredentials'|'AlreadyExists'|'NotFound'|'ResourceConflict'|'Throttling'|'ServiceLimitExceeded'|'NotStabilized'|'GeneralServiceException'|'ServiceInternalError'|'ServiceTimeout'|'NetworkFailure'|'InternalFailure',
'RetryAfter': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ResourceRequestStatusSummaries (list) --
The requests that match the specified filter criteria.
(dict) --
Represents the current status of a resource operation request. For more information, see Managing resource operation requests in the Amazon Web Services Cloud Control API User Guide .
TypeName (string) --
The name of the resource type used in the operation.
Identifier (string) --
The primary identifier for the resource.
Note
In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS .
RequestToken (string) --
The unique token representing this resource operation request.
Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.
Operation (string) --
The resource operation type.
OperationStatus (string) --
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.EventTime (datetime) --
When the resource operation request was initiated.
ResourceModel (string) --
A JSON string containing the resource model, consisting of each resource property and its current value.
StatusMessage (string) --
Any message explaining the current status.
ErrorCode (string) --
For requests with a status of FAILED , the associated error code.
For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development .
RetryAfter (datetime) --
When to next request the status of this resource operation request.
CloudControlApi.Paginator.ListResources¶paginator = client.get_paginator('list_resources')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from CloudControlApi.Client.list_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
TypeName='string',
TypeVersionId='string',
RoleArn='string',
ResourceModel='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the resource type.
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 section of the resource type definition schema.
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 in the Amazon Web Services Cloud Control API User Guide .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TypeName': 'string',
'ResourceDescriptions': [
{
'Identifier': 'string',
'Properties': 'string'
},
],
}
Response Structure
(dict) --
TypeName (string) --
The name of the resource type.
ResourceDescriptions (list) --
Information about the specified resources, including primary identifier and resource model.
(dict) --
Represents information about a provisioned resource.
Identifier (string) --
The primary identifier for the resource.
For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide .
Properties (string) --
A list of the resource properties and their current values.
The available waiters are:
CloudControlApi.Waiter.ResourceRequestSuccess¶waiter = client.get_waiter('resource_request_success')
wait(**kwargs)¶Polls CloudControlApi.Client.get_resource_request_status() every 5 seconds until a successful state is reached. An error is returned after 24 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
RequestToken='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
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.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 24
None