2020/10/19 - AWS Service Catalog - 9 updated api methods
Changes An Admin can now update the launch role associated with a Provisioned Product. Admins and End Users can now view the launch role associated with a Provisioned Product.
{'ProvisionedProductDetail': {'LaunchRoleArn': 'string'}}
Gets information about the specified provisioned product.
See also: AWS API Documentation
Request Syntax
client.describe_provisioned_product(
AcceptLanguage='string',
Id='string',
Name='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
The provisioned product identifier. You must provide the name or ID, but not both.
If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.
string
The name of the provisioned product. You must provide the name or ID, but not both.
If you do not provide a name or ID, or you provide both name and ID, an InvalidParametersException will occur.
dict
Response Syntax
{
'ProvisionedProductDetail': {
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'LaunchRoleArn': 'string'
},
'CloudWatchDashboards': [
{
'Name': 'string'
},
]
}
Response Structure
(dict) --
ProvisionedProductDetail (dict) --
Information about the provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
StatusMessage (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
CloudWatchDashboards (list) --
Any CloudWatch dashboards that were created when provisioning the product.
(dict) --
Information about a CloudWatch dashboard.
Name (string) --
The name of the CloudWatch dashboard.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Gets information about the specified request operation.
Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct ).
Note
If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.
See also: AWS API Documentation
Request Syntax
client.describe_record(
AcceptLanguage='string',
Id='string',
PageToken='string',
PageSize=123
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
[REQUIRED]
The record identifier of the provisioned product. This identifier is returned by the request operation.
string
The page token for the next set of results. To retrieve the first set of results, use null.
integer
The maximum number of items to return with this call.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
},
'RecordOutputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
RecordOutputs (list) --
Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
(dict) --
The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
OutputKey (string) --
The output key.
OutputValue (string) --
The output value.
Description (string) --
The description of the output.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Provisions or modifies a product based on the resource changes for the specified plan.
See also: AWS API Documentation
Request Syntax
client.execute_provisioned_product_plan(
AcceptLanguage='string',
PlanId='string',
IdempotencyToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
[REQUIRED]
The plan identifier.
string
[REQUIRED]
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Executes a self-service action against a provisioned product.
See also: AWS API Documentation
Request Syntax
client.execute_provisioned_product_service_action(
ProvisionedProductId='string',
ServiceActionId='string',
ExecuteToken='string',
AcceptLanguage='string',
Parameters={
'string': [
'string',
]
}
)
string
[REQUIRED]
The identifier of the provisioned product.
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz .
string
[REQUIRED]
An idempotency token that uniquely identifies the execute request.
This field is autopopulated if not provided.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET , the provided value will override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for any special parameters such as TARGET .
(string) --
(list) --
(string) --
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
An object containing detailed information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
{'RecordDetails': {'LaunchRoleArn': 'string'}}
Lists the specified requests or all performed requests.
See also: AWS API Documentation
Request Syntax
client.list_record_history(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
SearchFilter={
'Key': 'string',
'Value': 'string'
},
PageSize=123,
PageToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
The access level to use to obtain results. The default is User .
Key (string) --
The access level.
Account - Filter results based on the account.
Role - Filter results based on the federated role of the specified user.
User - Filter results based on the specified user.
Value (string) --
The user to which the access level applies. The only supported value is Self .
dict
The search filter to scope the results.
Key (string) --
The filter key.
product - Filter results based on the specified product identifier.
provisionedproduct - Filter results based on the provisioned product identifier.
Value (string) --
The filter value.
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
dict
Response Syntax
{
'RecordDetails': [
{
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetails (list) --
The records, in reverse chronological order.
(dict) --
Information about a request operation.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Provisions the specified product.
A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.
If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error "Parameter validation failed: Missing required parameter in Tags[N ]:Value ".
See also: AWS API Documentation
Request Syntax
client.provision_product(
AcceptLanguage='string',
ProductId='string',
ProductName='string',
ProvisioningArtifactId='string',
ProvisioningArtifactName='string',
PathId='string',
PathName='string',
ProvisionedProductName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string'
},
],
ProvisioningPreferences={
'StackSetAccounts': [
'string',
],
'StackSetRegions': [
'string',
],
'StackSetFailureToleranceCount': 123,
'StackSetFailureTolerancePercentage': 123,
'StackSetMaxConcurrencyCount': 123,
'StackSetMaxConcurrencyPercentage': 123
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationArns=[
'string',
],
ProvisionToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
The product identifier. You must provide the name or ID, but not both.
string
The name of the product. You must provide the name or ID, but not both.
string
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
string
The name of the provisioning artifact. You must provide the name or ID, but not both.
string
The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
string
The name of the path. You must provide the name or ID, but not both.
string
[REQUIRED]
A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.
list
Parameters specified by the administrator that are required for provisioning the product.
(dict) --
Information about a parameter used to provision a product.
Key (string) --
The parameter key.
Value (string) --
The parameter value.
dict
An object that contains information about the provisioning preferences for a stack set.
StackSetAccounts (list) --
One or more AWS accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.
If no values are specified, the default value is all accounts from the STACKSET constraint.
(string) --
StackSetRegions (list) --
One or more AWS Regions where the provisioned product will be available.
Applicable only to a CFN_STACKSET provisioned product type.
The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.
If no values are specified, the default value is all regions from the STACKSET constraint.
(string) --
StackSetFailureToleranceCount (integer) --
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.
The default value is 0 if no value is specified.
StackSetFailureTolerancePercentage (integer) --
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.
StackSetMaxConcurrencyCount (integer) --
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount . StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount .
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.
StackSetMaxConcurrencyPercentage (integer) --
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.
list
One or more tags.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The value for this key.
list
Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.
(string) --
string
[REQUIRED]
An idempotency token that uniquely identifies the provisioning request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of provisioning the product.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
{'ProvisionedProducts': {'LaunchRoleArn': 'string'}}
Lists the provisioned products that are available (not terminated).
To use additional filtering, see SearchProvisionedProducts.
See also: AWS API Documentation
Request Syntax
client.scan_provisioned_products(
AcceptLanguage='string',
AccessLevelFilter={
'Key': 'Account'|'Role'|'User',
'Value': 'string'
},
PageSize=123,
PageToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
The access level to use to obtain results. The default is User .
Key (string) --
The access level.
Account - Filter results based on the account.
Role - Filter results based on the federated role of the specified user.
User - Filter results based on the specified user.
Value (string) --
The user to which the access level applies. The only supported value is Self .
integer
The maximum number of items to return with this call.
string
The page token for the next set of results. To retrieve the first set of results, use null.
dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR'|'PLAN_IN_PROGRESS',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string',
'LastProvisioningRecordId': 'string',
'LastSuccessfulProvisioningRecordId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'LaunchRoleArn': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
Information about the provisioned products.
(dict) --
Information about a provisioned product.
Name (string) --
The user-friendly name of the provisioned product.
Arn (string) --
The ARN of the provisioned product.
Type (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
Id (string) --
The identifier of the provisioned product.
Status (string) --
The current status of the provisioned product.
AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.
StatusMessage (string) --
The current status message of the provisioned product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
IdempotencyToken (string) --
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
LastRecordId (string) --
The record identifier of the last request performed on this provisioned product.
LastProvisioningRecordId (string) --
The record identifier of the last request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
LastSuccessfulProvisioningRecordId (string) --
The record identifier of the last successful request performed on this provisioned product of the following types:
ProvisionedProduct
UpdateProvisionedProduct
ExecuteProvisionedProductPlan
TerminateProvisionedProduct
ProductId (string) --
The product identifier. For example, prod-abcdzk7xy33qa .
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Terminates the specified provisioned product.
This operation does not delete any records associated with the provisioned product.
You can check the status of this request using DescribeRecord.
See also: AWS API Documentation
Request Syntax
client.terminate_provisioned_product(
ProvisionedProductName='string',
ProvisionedProductId='string',
TerminateToken='string',
IgnoreErrors=True|False,
AcceptLanguage='string'
)
string
The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId .
string
The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId .
string
[REQUIRED]
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound .
This field is autopopulated if not provided.
boolean
If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of this request.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.
{'RecordDetail': {'LaunchRoleArn': 'string'}}
Requests updates to the configuration of the specified provisioned product.
If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.
You can check the status of this request using DescribeRecord.
See also: AWS API Documentation
Request Syntax
client.update_provisioned_product(
AcceptLanguage='string',
ProvisionedProductName='string',
ProvisionedProductId='string',
ProductId='string',
ProductName='string',
ProvisioningArtifactId='string',
ProvisioningArtifactName='string',
PathId='string',
PathName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
ProvisioningPreferences={
'StackSetAccounts': [
'string',
],
'StackSetRegions': [
'string',
],
'StackSetFailureToleranceCount': 123,
'StackSetFailureTolerancePercentage': 123,
'StackSetMaxConcurrencyCount': 123,
'StackSetMaxConcurrencyPercentage': 123,
'StackSetOperationType': 'CREATE'|'UPDATE'|'DELETE'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
UpdateToken='string'
)
string
The language code.
en - English (default)
jp - Japanese
zh - Chinese
string
The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId .
string
The identifier of the provisioned product. You must provide the name or ID, but not both.
string
The identifier of the product. You must provide the name or ID, but not both.
string
The name of the product. You must provide the name or ID, but not both.
string
The identifier of the provisioning artifact.
string
The name of the provisioning artifact. You must provide the name or ID, but not both.
string
The path identifier. This value is optional if the product has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.
string
The name of the path. You must provide the name or ID, but not both.
list
The new parameters.
(dict) --
The parameter key-value pair used to update a provisioned product.
Key (string) --
The parameter key.
Value (string) --
The parameter value.
UsePreviousValue (boolean) --
If set to true, Value is ignored and the previous parameter value is kept.
dict
An object that contains information about the provisioning preferences for a stack set.
StackSetAccounts (list) --
One or more AWS accounts that will have access to the provisioned product.
Applicable only to a CFN_STACKSET provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.
If no values are specified, the default value is all accounts from the STACKSET constraint.
(string) --
StackSetRegions (list) --
One or more AWS Regions where the provisioned product will be available.
Applicable only to a CFN_STACKSET provisioned product type.
The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.
If no values are specified, the default value is all regions from the STACKSET constraint.
(string) --
StackSetFailureToleranceCount (integer) --
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.
The default value is 0 if no value is specified.
StackSetFailureTolerancePercentage (integer) --
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage , but not both.
StackSetMaxConcurrencyCount (integer) --
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount . StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount .
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.
StackSetMaxConcurrencyPercentage (integer) --
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
Applicable only to a CFN_STACKSET provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage , but not both.
StackSetOperationType (string) --
Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.
Applicable only to a CFN_STACKSET provisioned product type.
CREATE
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
UPDATE
Updates the stack set represented by the provisioned product and also its stack instances.
DELETE
Deletes a stack instance in the stack set represented by the provisioned product.
list
One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.
(dict) --
Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.
Key (string) -- [REQUIRED]
The tag key.
Value (string) -- [REQUIRED]
The value for this key.
string
[REQUIRED]
The idempotency token that uniquely identifies the provisioning update request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'RecordDetail': {
'RecordId': 'string',
'ProvisionedProductName': 'string',
'Status': 'CREATED'|'IN_PROGRESS'|'IN_PROGRESS_IN_ERROR'|'SUCCEEDED'|'FAILED',
'CreatedTime': datetime(2015, 1, 1),
'UpdatedTime': datetime(2015, 1, 1),
'ProvisionedProductType': 'string',
'RecordType': 'string',
'ProvisionedProductId': 'string',
'ProductId': 'string',
'ProvisioningArtifactId': 'string',
'PathId': 'string',
'RecordErrors': [
{
'Code': 'string',
'Description': 'string'
},
],
'RecordTags': [
{
'Key': 'string',
'Value': 'string'
},
],
'LaunchRoleArn': 'string'
}
}
Response Structure
(dict) --
RecordDetail (dict) --
Information about the result of the request.
RecordId (string) --
The identifier of the record.
ProvisionedProductName (string) --
The user-friendly name of the provisioned product.
Status (string) --
The status of the provisioned product.
CREATED - The request was created but the operation has not started.
IN_PROGRESS - The requested operation is in progress.
IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
UpdatedTime (datetime) --
The time when the record was last updated.
ProvisionedProductType (string) --
The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET .
RecordType (string) --
The record type.
PROVISION_PRODUCT
UPDATE_PROVISIONED_PRODUCT
TERMINATE_PROVISIONED_PRODUCT
ProvisionedProductId (string) --
The identifier of the provisioned product.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The identifier of the provisioning artifact.
PathId (string) --
The path identifier.
RecordErrors (list) --
The errors that occurred.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The description of the error.
RecordTags (list) --
One or more tags.
(dict) --
Information about a tag, which is a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
LaunchRoleArn (string) --
The ARN of the launch role associated with the provisioned product.