2024/01/31 - AWS CloudFormation - 11 new api methods
Changes CloudFormation IaC generator allows you to scan existing resources in your account and select resources to generate a template for a new or existing CloudFormation stack.
Lists your generated templates in this Region.
See also: AWS API Documentation
Request Syntax
client.list_generated_templates(
NextToken='string',
MaxResults=123
)
string
A string that identifies the next page of resource scan results.
integer
If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListGeneratedTemplates API action will return at most 50 results in each response. The maximum value is 100.
dict
Response Syntax
{
'Summaries': [
{
'GeneratedTemplateId': 'string',
'GeneratedTemplateName': 'string',
'Status': 'CREATE_PENDING'|'UPDATE_PENDING'|'DELETE_PENDING'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'COMPLETE',
'StatusReason': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'NumberOfResources': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Summaries (list) --
A list of summaries of the generated templates.
(dict) --
The summary of a generated template.
GeneratedTemplateId (string) --
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id} . For example, ``arn:aws:cloudformation:us-east-1 :123456789012 :generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `` .
GeneratedTemplateName (string) --
The name of the generated template.
Status (string) --
The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
StatusReason (string) --
The reason for the current template generation status. This will provide more details if a failure happened.
CreationTime (datetime) --
The time the generated template was created.
LastUpdatedTime (datetime) --
The time the generated template was last updated.
NumberOfResources (integer) --
The number of resources in the generated template. This is a total of resources in pending, in-progress, completed, and failed states.
NextToken (string) --
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListGeneratedTemplates again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.
See also: AWS API Documentation
Request Syntax
client.list_resource_scan_related_resources(
ResourceScanId='string',
Resources=[
{
'ResourceType': 'string',
'ResourceIdentifier': {
'string': 'string'
}
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource scan.
list
[REQUIRED]
The list of resources for which you want to get the related resources. Up to 100 resources can be provided.
(dict) --
Identifies a scanned resource. This is used with the ListResourceScanRelatedResources API action.
ResourceType (string) -- [REQUIRED]
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
ResourceIdentifier (dict) -- [REQUIRED]
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
string
A string that identifies the next page of resource scan results.
integer
If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanRelatedResources API action will return up to 100 results in each response. The maximum value is 100.
dict
Response Syntax
{
'RelatedResources': [
{
'ResourceType': 'string',
'ResourceIdentifier': {
'string': 'string'
},
'ManagedByStack': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RelatedResources (list) --
List of up to MaxResults resources in the specified resource scan related to the specified resources.
(dict) --
A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources .
ResourceType (string) --
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
ResourceIdentifier (dict) --
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
ManagedByStack (boolean) --
If true , the resource is managed by a CloudFormation stack.
NextToken (string) --
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanRelatedResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
Describes details of a resource scan.
See also: AWS API Documentation
Request Syntax
client.describe_resource_scan(
ResourceScanId='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource scan.
dict
Response Syntax
{
'ResourceScanId': 'string',
'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETE'|'EXPIRED',
'StatusReason': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'PercentageCompleted': 123.0,
'ResourceTypes': [
'string',
],
'ResourcesScanned': 123,
'ResourcesRead': 123
}
Response Structure
(dict) --
ResourceScanId (string) --
The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id} . An example is ``arn:aws:cloudformation:us-east-1 :123456789012 :resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 `` .
Status (string) --
Status of the resource scan.
INPROGRESS
The resource scan is still in progress.
COMPLETE
The resource scan is complete.
EXPIRED
The resource scan has expired.
FAILED
The resource scan has failed.
StatusReason (string) --
The reason for the resource scan status, providing more information if a failure happened.
StartTime (datetime) --
The time that the resource scan was started.
EndTime (datetime) --
The time that the resource scan was finished.
PercentageCompleted (float) --
The percentage of the resource scan that has been completed.
ResourceTypes (list) --
The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .
(string) --
ResourcesScanned (integer) --
The number of resources that were listed. This is only available for scans with a Status set to COMPLETE , EXPIRED , or FAILED .
ResourcesRead (integer) --
The number of resources that were read. This is only available for scans with a Status set to COMPLETE , EXPIRED , or FAILED .
Note
This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException .
Lists the resources from a resource scan. The results can be filtered by resource identifier, resource type prefix, tag key, and tag value. Only resources that match all specified filters are returned. The response indicates whether each returned resource is already managed by CloudFormation.
See also: AWS API Documentation
Request Syntax
client.list_resource_scan_resources(
ResourceScanId='string',
ResourceIdentifier='string',
ResourceTypePrefix='string',
TagKey='string',
TagValue='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the resource scan.
string
If specified, the returned resources will have the specified resource identifier (or one of them in the case where the resource has multiple identifiers).
string
If specified, the returned resources will be of any of the resource types with the specified prefix.
string
If specified, the returned resources will have a matching tag key.
string
If specified, the returned resources will have a matching tag value.
string
A string that identifies the next page of resource scan results.
integer
If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the ListResourceScanResources API action will return at most 100 results in each response. The maximum value is 100.
dict
Response Syntax
{
'Resources': [
{
'ResourceType': 'string',
'ResourceIdentifier': {
'string': 'string'
},
'ManagedByStack': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Resources (list) --
List of up to MaxResults resources in the specified resource scan that match all of the specified filters.
(dict) --
A scanned resource returned by ListResourceScanResources or ListResourceScanRelatedResources .
ResourceType (string) --
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
ResourceIdentifier (dict) --
A list of up to 256 key-value pairs that identifies for the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
ManagedByStack (boolean) --
If true , the resource is managed by a CloudFormation stack.
NextToken (string) --
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScanResources again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
Updates a generated template. This can be used to change the name, add and remove resources, refresh resources, and change the DeletionPolicy and UpdateReplacePolicy settings. You can check the status of the update to the generated template using the DescribeGeneratedTemplate API action.
See also: AWS API Documentation
Request Syntax
client.update_generated_template(
GeneratedTemplateName='string',
NewGeneratedTemplateName='string',
AddResources=[
{
'ResourceType': 'string',
'LogicalResourceId': 'string',
'ResourceIdentifier': {
'string': 'string'
}
},
],
RemoveResources=[
'string',
],
RefreshAllResources=True|False,
TemplateConfiguration={
'DeletionPolicy': 'DELETE'|'RETAIN',
'UpdateReplacePolicy': 'DELETE'|'RETAIN'
}
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of a generated template.
string
An optional new name to assign to the generated template.
list
An optional list of resources to be added to the generated template.
(dict) --
A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.
ResourceType (string) -- [REQUIRED]
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
LogicalResourceId (string) --
The logical resource id for this resource in the generated template.
ResourceIdentifier (dict) -- [REQUIRED]
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
list
A list of logical ids for resources to remove from the generated template.
(string) --
boolean
If true , update the resource properties in the generated template with their current live state. This feature is useful when the resource properties in your generated a template does not reflect the live state of the resource properties. This happens when a user update the resource properties after generating a template.
dict
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy .
DeletionPolicy (string) --
The DeletionPolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the stack is deleted.
RETAIN - retain all resources when the stack is deleted.
For more information, see ` DeletionPolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html>`__ in the CloudFormation User Guide .
UpdateReplacePolicy (string) --
The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the resource is replaced during an update operation.
RETAIN - retain all resources when the resource is replaced during an update operation.
For more information, see ` UpdateReplacePolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html>`__ in the CloudFormation User Guide .
dict
Response Syntax
{
'GeneratedTemplateId': 'string'
}
Response Structure
(dict) --
GeneratedTemplateId (string) --
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id} . For example, ``arn:aws:cloudformation:us-east-1 :123456789012 :generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `` .
Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.
See also: AWS API Documentation
Request Syntax
client.create_generated_template(
Resources=[
{
'ResourceType': 'string',
'LogicalResourceId': 'string',
'ResourceIdentifier': {
'string': 'string'
}
},
],
GeneratedTemplateName='string',
StackName='string',
TemplateConfiguration={
'DeletionPolicy': 'DELETE'|'RETAIN',
'UpdateReplacePolicy': 'DELETE'|'RETAIN'
}
)
list
An optional list of resources to be included in the generated template.
If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.
(dict) --
A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.
ResourceType (string) -- [REQUIRED]
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
LogicalResourceId (string) --
The logical resource id for this resource in the generated template.
ResourceIdentifier (dict) -- [REQUIRED]
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
string
[REQUIRED]
The name assigned to the generated template.
string
An optional name or ARN of a stack to use as the base stack for the generated template.
dict
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy .
DeletionPolicy (string) --
The DeletionPolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the stack is deleted.
RETAIN - retain all resources when the stack is deleted.
For more information, see ` DeletionPolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html>`__ in the CloudFormation User Guide .
UpdateReplacePolicy (string) --
The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the resource is replaced during an update operation.
RETAIN - retain all resources when the resource is replaced during an update operation.
For more information, see ` UpdateReplacePolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html>`__ in the CloudFormation User Guide .
dict
Response Syntax
{
'GeneratedTemplateId': 'string'
}
Response Structure
(dict) --
GeneratedTemplateId (string) --
The ID of the generated template.
Retrieves a generated template. If the template is in an InProgress or Pending status then the template returned will be the template when the template was last in a Complete status. If the template has not yet been in a Complete status then an empty template will be returned.
See also: AWS API Documentation
Request Syntax
client.get_generated_template(
Format='JSON'|'YAML',
GeneratedTemplateName='string'
)
string
The language to use to retrieve for the generated template. Supported values are:
JSON
YAML
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id} . For example, ``arn:aws:cloudformation:us-east-1 :123456789012 :generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `` .
dict
Response Syntax
{
'Status': 'CREATE_PENDING'|'UPDATE_PENDING'|'DELETE_PENDING'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'COMPLETE',
'TemplateBody': 'string'
}
Response Structure
(dict) --
Status (string) --
The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
TemplateBody (string) --
The template body of the generated template, in the language specified by the Language parameter.
Deleted a generated template.
See also: AWS API Documentation
Request Syntax
client.delete_generated_template(
GeneratedTemplateName='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of a generated template.
None
List the resource scans from newest to oldest. By default it will return up to 10 resource scans.
See also: AWS API Documentation
Request Syntax
client.list_resource_scans(
NextToken='string',
MaxResults=123
)
string
A string that identifies the next page of resource scan results.
integer
If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. The default value is 10. The maximum value is 100.
dict
Response Syntax
{
'ResourceScanSummaries': [
{
'ResourceScanId': 'string',
'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETE'|'EXPIRED',
'StatusReason': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'PercentageCompleted': 123.0
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceScanSummaries (list) --
The list of scans returned.
(dict) --
A summary of the resource scan. This is returned by the ListResourceScan API action.
ResourceScanId (string) --
The Amazon Resource Name (ARN) of the resource scan.
Status (string) --
Status of the resource scan.
INPROGRESS
The resource scan is still in progress.
COMPLETE
The resource scan is complete.
EXPIRED
The resource scan has expired.
FAILED
The resource scan has failed.
StatusReason (string) --
The reason for the resource scan status, providing more information if a failure happened.
StartTime (datetime) --
The time that the resource scan was started.
EndTime (datetime) --
The time that the resource scan was finished.
PercentageCompleted (float) --
The percentage of the resource scan that has been completed.
NextToken (string) --
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResourceScans again and use that value for the NextToken parameter. If the request returns all results, NextToken is set to an empty string.
Describes a generated template. The output includes details about the progress of the creation of a generated template started by a CreateGeneratedTemplate API action or the update of a generated template started with an UpdateGeneratedTemplate API action.
See also: AWS API Documentation
Request Syntax
client.describe_generated_template(
GeneratedTemplateName='string'
)
string
[REQUIRED]
The name or Amazon Resource Name (ARN) of a generated template.
dict
Response Syntax
{
'GeneratedTemplateId': 'string',
'GeneratedTemplateName': 'string',
'Resources': [
{
'ResourceType': 'string',
'LogicalResourceId': 'string',
'ResourceIdentifier': {
'string': 'string'
},
'ResourceStatus': 'PENDING'|'IN_PROGRESS'|'FAILED'|'COMPLETE',
'ResourceStatusReason': 'string',
'Warnings': [
{
'Type': 'MUTUALLY_EXCLUSIVE_PROPERTIES'|'UNSUPPORTED_PROPERTIES'|'MUTUALLY_EXCLUSIVE_TYPES',
'Properties': [
{
'PropertyPath': 'string',
'Required': True|False,
'Description': 'string'
},
]
},
]
},
],
'Status': 'CREATE_PENDING'|'UPDATE_PENDING'|'DELETE_PENDING'|'CREATE_IN_PROGRESS'|'UPDATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'FAILED'|'COMPLETE',
'StatusReason': 'string',
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Progress': {
'ResourcesSucceeded': 123,
'ResourcesFailed': 123,
'ResourcesProcessing': 123,
'ResourcesPending': 123
},
'StackId': 'string',
'TemplateConfiguration': {
'DeletionPolicy': 'DELETE'|'RETAIN',
'UpdateReplacePolicy': 'DELETE'|'RETAIN'
},
'TotalWarnings': 123
}
Response Structure
(dict) --
GeneratedTemplateId (string) --
The Amazon Resource Name (ARN) of the generated template. The format is arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id} . For example, ``arn:aws:cloudformation:us-east-1 :123456789012 :generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc `` .
GeneratedTemplateName (string) --
The name of the generated template.
Resources (list) --
A list of objects describing the details of the resources in the template generation.
(dict) --
Details about a resource in a generated template
ResourceType (string) --
The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide
LogicalResourceId (string) --
The logical id for this resource in the final generated template.
ResourceIdentifier (dict) --
A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .
(string) --
(string) --
ResourceStatus (string) --
Status of the processing of a resource in a generated template.
InProgress
The resource processing is still in progress.
Complete
The resource processing is complete.
Pending
The resource processing is pending.
Failed
The resource processing has failed.
ResourceStatusReason (string) --
The reason for the resource detail, providing more information if a failure happened.
Warnings (list) --
The warnings generated for this resource.
(dict) --
The warnings generated for a specific resource for this generated template.
Type (string) --
The type of this warning. For more information, see IaC generator and write-only properties in the CloudFormation User Guide .
MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.
UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.
MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.
Note
Currently the resource and property reference documentation does not indicate if a property uses a type of oneOf or anyOf . You need to look at the resource provider schema.
Properties (list) --
The properties of the resource that are impacted by this warning.
(dict) --
A specific property that is impacted by a warning.
PropertyPath (string) --
The path of the property. For example, if this is for the S3Bucket member of the Code property, the property path would be Code/S3Bucket .
Required (boolean) --
If true , the specified property is required.
Description (string) --
The description of the property from the resource provider schema.
Status (string) --
The status of the template generation. Supported values are:
CreatePending - the creation of the template is pending.
CreateInProgress - the creation of the template is in progress.
DeletePending - the deletion of the template is pending.
DeleteInProgress - the deletion of the template is in progress.
UpdatePending - the update of the template is pending.
UpdateInProgress - the update of the template is in progress.
Failed - the template operation failed.
Complete - the template operation is complete.
StatusReason (string) --
The reason for the current template generation status. This will provide more details if a failure happened.
CreationTime (datetime) --
The time the generated template was created.
LastUpdatedTime (datetime) --
The time the generated template was last updated.
Progress (dict) --
An object describing the progress of the template generation.
ResourcesSucceeded (integer) --
The number of resources that succeeded the template generation.
ResourcesFailed (integer) --
The number of resources that failed the template generation.
ResourcesProcessing (integer) --
The number of resources that are in-process for the template generation.
ResourcesPending (integer) --
The number of resources that are still pending the template generation.
StackId (string) --
The stack ARN of the base stack if a base stack was provided when generating the template.
TemplateConfiguration (dict) --
The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy .
DeletionPolicy (string) --
The DeletionPolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the stack is deleted.
RETAIN - retain all resources when the stack is deleted.
For more information, see ` DeletionPolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html>`__ in the CloudFormation User Guide .
UpdateReplacePolicy (string) --
The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:
DELETE - delete all resources when the resource is replaced during an update operation.
RETAIN - retain all resources when the resource is replaced during an update operation.
For more information, see ` UpdateReplacePolicy attribute <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html>`__ in the CloudFormation User Guide .
TotalWarnings (integer) --
The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
Starts a scan of the resources in this account in this Region. You can the status of a scan using the ListResourceScans API action.
See also: AWS API Documentation
Request Syntax
client.start_resource_scan(
ClientRequestToken='string'
)
string
A unique identifier for this StartResourceScan request. Specify this token if you plan to retry requests so that CloudFormation knows that you're not attempting to start a new resource scan.
dict
Response Syntax
{
'ResourceScanId': 'string'
}
Response Structure
(dict) --
ResourceScanId (string) --
The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id} . An example is ``arn:aws:cloudformation:us-east-1 :123456789012 :resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 `` .