2017/06/15 - AWS Service Catalog - 1 new 17 updated api methods
Changes Added ProvisioningArtifactSummaries to DescribeProductAsAdmin's output to show the provisioning artifacts belong to the product. Allow filtering by SourceProductId in SearchProductsAsAdmin for AWS Marketplace products. Added a verbose option to DescribeProvisioningArtifact to display the CloudFormation template used to create the provisioning artifact.Added DescribeProvisionedProduct API. Changed the type of ProvisionedProduct's Status to be distinct from Record's Status. New ProvisionedProduct's Status are AVAILABLE, UNDER_CHANGE, TAINTED, ERROR. Changed Record's Status set of values to CREATED, IN_PROGRESS, IN_PROGRESS_IN_ERROR, SUCCEEDED, FAILED.
Retrieve detailed information about the provisioned product.
See also: AWS API Documentation
Request Syntax
client.describe_provisioned_product(
AcceptLanguage='string',
Id='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The provisioned product identifier.
dict
Response Syntax
{
'ProvisionedProductDetail': {
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string'
}
}
Response Structure
(dict) --
ProvisionedProductDetail (dict) --
Detailed provisioned product information.
Name (string) --
The user-friendly name of the ProvisionedProduct object.
Arn (string) --
The ARN associated with the ProvisionedProduct object.
Type (string) --
The type of the ProvisionedProduct object.
Id (string) --
The identifier of the ProvisionedProduct object.
Status (string) --
The current status of the ProvisionedProduct.
AVAILABLE - Stable state, ready to perform any operation. The most recent action request succeeded and completed.
UNDER_CHANGE - Transitive state, operations performed may or may 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 - Something unexpected happened such that the provisioned product exists but the stack is not running. For example, CloudFormation received an invalid parameter value and could not launch the stack.
StatusMessage (string) --
The current status message of the ProvisionedProduct.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
IdempotencyToken (string) --
A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
LastRecordId (string) --
The record identifier of the last request performed on this ProvisionedProduct object.
{'ProductType': ['MARKETPLACE'],
'ProvisioningArtifactParameters': {'Type': ['MARKETPLACE_AMI',
'MARKETPLACE_CAR']}}
Response {'ProductViewDetail': {'ProductViewSummary': {'Type': ['MARKETPLACE']}},
'ProvisioningArtifactDetail': {'Type': ['MARKETPLACE_AMI', 'MARKETPLACE_CAR']}}
Creates a new product.
See also: AWS API Documentation
Request Syntax
client.create_product(
AcceptLanguage='string',
Name='string',
Owner='string',
Description='string',
Distributor='string',
SupportDescription='string',
SupportEmail='string',
SupportUrl='string',
ProductType='CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ProvisioningArtifactParameters={
'Name': 'string',
'Description': 'string',
'Info': {
'string': 'string'
},
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'
},
IdempotencyToken='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The name of the product.
string
[REQUIRED]
The owner of the product.
string
The text description of the product.
string
The distributor of the product.
string
Support information about the product.
string
Contact email for product support.
string
Contact URL for product support.
string
[REQUIRED]
The type of the product to create.
list
Tags to associate with the new product.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) -- [REQUIRED]
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) -- [REQUIRED]
The desired value for this key.
dict
[REQUIRED]
Parameters for the provisioning artifact.
Name (string) --
The name assigned to the provisioning artifact properties.
Description (string) --
The text description of the provisioning artifact properties.
Info (dict) -- [REQUIRED]
Additional information about the provisioning artifact properties. When using this element in a request, you must specify LoadTemplateFromURL . For more information, see CreateProvisioningArtifact .
(string) --
(string) --
Type (string) --
The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
string
[REQUIRED]
A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
The resulting detailed product view information.
ProductViewSummary (dict) --
The summary metadata about the specified product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
Current status of the product.
AVAILABLE - Product is available for use.
CREATING - Creation of product started, not ready for use.
FAILED - Action on product failed.
ProductARN (string) --
The ARN associated with the product.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
ProvisioningArtifactDetail (dict) --
The resulting detailed provisioning artifact information.
Id (string) --
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
Name (string) --
The name assigned to the provisioning artifact.
Description (string) --
The text description of the provisioning artifact.
Type (string) --
The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
Tags (list) --
Tags successfully associated with the new product.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) --
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) --
The desired value for this key.
{'Parameters': {'Type': ['MARKETPLACE_AMI', 'MARKETPLACE_CAR']}}
Response {'ProvisioningArtifactDetail': {'Type': ['MARKETPLACE_AMI', 'MARKETPLACE_CAR']}}
Create a new provisioning artifact for the specified product. This operation does not work with a product that has been shared with you.
See the bottom of this topic for an example JSON request.
See also: AWS API Documentation
Request Syntax
client.create_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
Parameters={
'Name': 'string',
'Description': 'string',
'Info': {
'string': 'string'
},
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'
},
IdempotencyToken='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The product identifier.
dict
[REQUIRED]
The parameters to use when creating the new provisioning artifact.
Name (string) --
The name assigned to the provisioning artifact properties.
Description (string) --
The text description of the provisioning artifact properties.
Info (dict) -- [REQUIRED]
Additional information about the provisioning artifact properties. When using this element in a request, you must specify LoadTemplateFromURL . For more information, see CreateProvisioningArtifact .
(string) --
(string) --
Type (string) --
The type of the provisioning artifact properties. The following provisioning artifact property types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
string
[REQUIRED]
A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
The resulting detailed provisioning artifact information.
Id (string) --
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
Name (string) --
The name assigned to the provisioning artifact.
Description (string) --
The text description of the provisioning artifact.
Type (string) --
The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
Info (dict) --
Additional information about the creation request for the provisioning artifact.
(string) --
(string) --
Status (string) --
The status of the current request.
{'ProductViewSummary': {'Type': ['MARKETPLACE']}}
Retrieves information about a specified product.
This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId .
See also: AWS API Documentation
Request Syntax
client.describe_product(
AcceptLanguage='string',
Id='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The ProductId of the product to describe.
dict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
The summary metadata about the specified product.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifacts (list) --
A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts parameter represent the ways the specified product can be provisioned.
(dict) --
Contains information indicating the ways in which a product can be provisioned.
Id (string) --
The identifier for the artifact. This is sometimes referred to as the product version.
Name (string) --
The name of the artifact.
Description (string) --
The text description of the artifact.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
{'ProductViewDetail': {'ProductViewSummary': {'Type': ['MARKETPLACE']}},
'ProvisioningArtifactSummaries': [{'CreatedTime': 'timestamp',
'Description': 'string',
'Id': 'string',
'Name': 'string',
'ProvisioningArtifactMetadata': {'string': 'string'}}]}
Retrieves information about a specified product, run with administrator access.
See also: AWS API Documentation
Request Syntax
client.describe_product_as_admin(
AcceptLanguage='string',
Id='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The identifier of the product for which to retrieve information.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'ProvisioningArtifactSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProvisioningArtifactMetadata': {
'string': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Detailed product view information.
ProductViewSummary (dict) --
The summary metadata about the specified product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
Current status of the product.
AVAILABLE - Product is available for use.
CREATING - Creation of product started, not ready for use.
FAILED - Action on product failed.
ProductARN (string) --
The ARN associated with the product.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
ProvisioningArtifactSummaries (list) --
A list of provisioning artifact summaries for the product.
(dict) --
Summary information about a provisioning artifact.
Id (string) --
The provisioning artifact identifier.
Name (string) --
The provisioning artifact name.
Description (string) --
The provisioning artifact description.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
ProvisioningArtifactMetadata (dict) --
The provisioning artifact metadata. This data is used with products created by AWS Marketplace.
(string) --
(string) --
Tags (list) --
Tags associated with the product.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) --
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) --
The desired value for this key.
{'ProductViewSummary': {'Type': ['MARKETPLACE']}}
Retrieves information about a specified product.
This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId .
See also: AWS API Documentation
Request Syntax
client.describe_product_view(
AcceptLanguage='string',
Id='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The ProductViewId of the product to describe.
dict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
The summary metadata about the specified product.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProvisioningArtifacts (list) --
A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts represent the ways in which the specified product can be provisioned.
(dict) --
Contains information indicating the ways in which a product can be provisioned.
Id (string) --
The identifier for the artifact. This is sometimes referred to as the product version.
Name (string) --
The name of the artifact.
Description (string) --
The text description of the artifact.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
{'Verbose': 'boolean'}
Response {'ProvisioningArtifactDetail': {'Type': ['MARKETPLACE_AMI', 'MARKETPLACE_CAR']}}
Retrieves detailed information about the specified provisioning artifact.
See also: AWS API Documentation
Request Syntax
client.describe_provisioning_artifact(
AcceptLanguage='string',
ProvisioningArtifactId='string',
ProductId='string',
Verbose=True|False
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
string
[REQUIRED]
The product identifier.
boolean
Selects verbose results. If set to true, the CloudFormation template is returned.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Detailed provisioning artifact information.
Id (string) --
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
Name (string) --
The name assigned to the provisioning artifact.
Description (string) --
The text description of the provisioning artifact.
Type (string) --
The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
Info (dict) --
Additional information about the provisioning artifact.
(string) --
(string) --
Status (string) --
The status of the current request.
{'RecordDetail': {'Status': ['FAILED', 'IN_PROGRESS_IN_ERROR', 'CREATED']}}
Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation ( ProvisionProduct , TerminateProvisionedProduct , or UpdateProvisionedProduct ).
See also: AWS API Documentation
Request Syntax
client.describe_record(
AcceptLanguage='string',
Id='string',
PageToken='string',
PageSize=123
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.
string
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
integer
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
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'
},
]
},
'RecordOutputs': [
{
'OutputKey': 'string',
'OutputValue': 'string',
'Description': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetail (dict) --
Detailed record information for the specified product.
RecordId (string) --
The identifier of the ProvisionedProduct object record.
ProvisionedProductName (string) --
The user-friendly name of the ProvisionedProduct object.
Status (string) --
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet 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 roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
UpdatedTime (datetime) --
The time when the record for the ProvisionedProduct object was last updated.
ProvisionedProductType (string) --
The type of the ProvisionedProduct object.
RecordType (string) --
The record type for this record.
ProvisionedProductId (string) --
The identifier of the ProvisionedProduct object.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
PathId (string) --
The identifier of the path for this product's provisioning.
RecordErrors (list) --
A list of errors that occurred while processing the request.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The text description of the error.
RecordTags (list) --
List of tags associated with this record.
(dict) --
A tag associated with the record, stored as a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
RecordOutputs (list) --
A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
(dict) --
An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.
OutputKey (string) --
The output key.
OutputValue (string) --
The output value.
Description (string) --
The text description of the output.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProvisioningArtifactDetails': {'Type': ['MARKETPLACE_AMI',
'MARKETPLACE_CAR']}}
Lists all provisioning artifacts associated with the specified product.
See also: AWS API Documentation
Request Syntax
client.list_provisioning_artifacts(
AcceptLanguage='string',
ProductId='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The product identifier.
dict
Response Syntax
{
'ProvisioningArtifactDetails': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactDetails (list) --
List of detailed provisioning artifact information objects.
(dict) --
Detailed provisioning artifact information.
Id (string) --
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
Name (string) --
The name assigned to the provisioning artifact.
Description (string) --
The text description of the provisioning artifact.
Type (string) --
The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'RecordDetails': {'Status': ['FAILED', 'IN_PROGRESS_IN_ERROR', 'CREATED']}}
Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.
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 to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
dict
The access level for obtaining results. If left unspecified, User level access is used.
Key (string) --
Specifies the access level.
Account allows results at the account level.
Role allows results based on the federated role of the specified user.
User allows results limited to the specified user.
Value (string) --
Specifies the user to which the access level applies. A value of Self is currently supported.
dict
The filter to limit search results.
Key (string) --
The filter key.
Value (string) --
The filter value for Key .
integer
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
string
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
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'
},
]
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
RecordDetails (list) --
A list of record detail objects, listed in reverse chronological order.
(dict) --
The full details of a specific ProvisionedProduct object.
RecordId (string) --
The identifier of the ProvisionedProduct object record.
ProvisionedProductName (string) --
The user-friendly name of the ProvisionedProduct object.
Status (string) --
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet 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 roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
UpdatedTime (datetime) --
The time when the record for the ProvisionedProduct object was last updated.
ProvisionedProductType (string) --
The type of the ProvisionedProduct object.
RecordType (string) --
The record type for this record.
ProvisionedProductId (string) --
The identifier of the ProvisionedProduct object.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
PathId (string) --
The identifier of the path for this product's provisioning.
RecordErrors (list) --
A list of errors that occurred while processing the request.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The text description of the error.
RecordTags (list) --
List of tags associated with this record.
(dict) --
A tag associated with the record, stored as a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'RecordDetail': {'Status': ['FAILED', 'IN_PROGRESS_IN_ERROR', 'CREATED']}}
Requests a provision of a specified product. A provisioned product is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.
You can check the status of this request using the DescribeRecord operation.
See also: AWS API Documentation
Request Syntax
client.provision_product(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
PathId='string',
ProvisionedProductName='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
NotificationArns=[
'string',
],
ProvisionToken='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The product identifier.
string
[REQUIRED]
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
string
The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
string
[REQUIRED]
A user-friendly name to identify the ProvisionedProduct object. 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) --
The parameter key-value pairs used to provision a product.
Key (string) --
The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters .
Value (string) --
The value to use for provisioning. Any constraints on this value can be found in ProvisioningArtifactParameter for Key .
list
A list of tags to use as provisioning options.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) -- [REQUIRED]
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) -- [REQUIRED]
The desired 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'
},
]
}
}
Response Structure
(dict) --
RecordDetail (dict) --
The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.
RecordId (string) --
The identifier of the ProvisionedProduct object record.
ProvisionedProductName (string) --
The user-friendly name of the ProvisionedProduct object.
Status (string) --
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet 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 roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
UpdatedTime (datetime) --
The time when the record for the ProvisionedProduct object was last updated.
ProvisionedProductType (string) --
The type of the ProvisionedProduct object.
RecordType (string) --
The record type for this record.
ProvisionedProductId (string) --
The identifier of the ProvisionedProduct object.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
PathId (string) --
The identifier of the path for this product's provisioning.
RecordErrors (list) --
A list of errors that occurred while processing the request.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The text description of the error.
RecordTags (list) --
List of tags associated with this record.
(dict) --
A tag associated with the record, stored as a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
{'ProvisionedProducts': {'Status': ['UNDER_CHANGE', 'TAINTED', 'AVAILABLE']}}
Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).
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 to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
dict
The access level for obtaining results. If left unspecified, User level access is used.
Key (string) --
Specifies the access level.
Account allows results at the account level.
Role allows results based on the federated role of the specified user.
User allows results limited to the specified user.
Value (string) --
Specifies the user to which the access level applies. A value of Self is currently supported.
integer
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
string
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
dict
Response Syntax
{
'ProvisionedProducts': [
{
'Name': 'string',
'Arn': 'string',
'Type': 'string',
'Id': 'string',
'Status': 'AVAILABLE'|'UNDER_CHANGE'|'TAINTED'|'ERROR',
'StatusMessage': 'string',
'CreatedTime': datetime(2015, 1, 1),
'IdempotencyToken': 'string',
'LastRecordId': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisionedProducts (list) --
A list of ProvisionedProduct detail objects.
(dict) --
Detailed information about a ProvisionedProduct object.
Name (string) --
The user-friendly name of the ProvisionedProduct object.
Arn (string) --
The ARN associated with the ProvisionedProduct object.
Type (string) --
The type of the ProvisionedProduct object.
Id (string) --
The identifier of the ProvisionedProduct object.
Status (string) --
The current status of the ProvisionedProduct.
AVAILABLE - Stable state, ready to perform any operation. The most recent action request succeeded and completed.
UNDER_CHANGE - Transitive state, operations performed may or may 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 - Something unexpected happened such that the provisioned product exists but the stack is not running. For example, CloudFormation received an invalid parameter value and could not launch the stack.
StatusMessage (string) --
The current status message of the ProvisionedProduct.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
IdempotencyToken (string) --
A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.
LastRecordId (string) --
The record identifier of the last request performed on this ProvisionedProduct object.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProductViewSummaries': {'Type': ['MARKETPLACE']}}
Returns a paginated list all of the Products objects to which the caller has access.
The output of this operation can be used as input for other operations, such as DescribeProductView .
See also: AWS API Documentation
Request Syntax
client.search_products(
AcceptLanguage='string',
Filters={
'string': [
'string',
]
},
PageSize=123,
SortBy='Title'|'VersionCount'|'CreationDate',
SortOrder='ASCENDING'|'DESCENDING',
PageToken='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
dict
The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.
(string) --
(list) --
(string) --
integer
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
string
The sort field specifier. If no value is specified, results are not sorted.
string
The sort order specifier. If no value is specified, results are not sorted.
string
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
dict
Response Syntax
{
'ProductViewSummaries': [
{
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
],
'ProductViewAggregations': {
'string': [
{
'Value': 'string',
'ApproximateCount': 123
},
]
},
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewSummaries (list) --
A list of the product view summary objects.
(dict) --
The summary metadata about the specified product.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
ProductViewAggregations (dict) --
A list of the product view aggregation value objects.
(string) --
(list) --
(dict) --
A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
Value (string) --
The value of the product view aggregation.
ApproximateCount (integer) --
An approximate count of the products that match the value.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'ProductViewDetails': {'ProductViewSummary': {'Type': ['MARKETPLACE']}}}
Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.
See also: AWS API Documentation
Request Syntax
client.search_products_as_admin(
AcceptLanguage='string',
PortfolioId='string',
Filters={
'string': [
'string',
]
},
SortBy='Title'|'VersionCount'|'CreationDate',
SortOrder='ASCENDING'|'DESCENDING',
PageToken='string',
PageSize=123,
ProductSource='ACCOUNT'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
The portfolio identifier.
dict
The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.
(string) --
(list) --
(string) --
string
The sort field specifier. If no value is specified, results are not sorted.
string
The sort order specifier. If no value is specified, results are not sorted.
string
The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .
integer
The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.
string
Access level of the source of the product.
dict
Response Syntax
{
'ProductViewDetails': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewDetails (list) --
List of detailed product view information objects.
(dict) --
Detailed product view information.
ProductViewSummary (dict) --
The summary metadata about the specified product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
Current status of the product.
AVAILABLE - Product is available for use.
CREATING - Creation of product started, not ready for use.
FAILED - Action on product failed.
ProductARN (string) --
The ARN associated with the product.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
NextPageToken (string) --
The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
{'RecordDetail': {'Status': ['FAILED', 'IN_PROGRESS_IN_ERROR', 'CREATED']}}
Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.
This operation does not delete any records associated with the ProvisionedProduct object.
You can check the status of this request using the DescribeRecord operation.
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 ProvisionedProduct object to terminate. Specify either ProvisionedProductName or ProvisionedProductId , but not both.
string
The identifier of the ProvisionedProduct object to terminate. Specify either ProvisionedProductName or ProvisionedProductId , but not both.
string
[REQUIRED]
An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return ResourceNotFound regardless of the value of TerminateToken .
This field is autopopulated if not provided.
boolean
If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources.
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
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'
},
]
}
}
Response Structure
(dict) --
RecordDetail (dict) --
The detailed result of the TerminateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
RecordId (string) --
The identifier of the ProvisionedProduct object record.
ProvisionedProductName (string) --
The user-friendly name of the ProvisionedProduct object.
Status (string) --
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet 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 roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
UpdatedTime (datetime) --
The time when the record for the ProvisionedProduct object was last updated.
ProvisionedProductType (string) --
The type of the ProvisionedProduct object.
RecordType (string) --
The record type for this record.
ProvisionedProductId (string) --
The identifier of the ProvisionedProduct object.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
PathId (string) --
The identifier of the path for this product's provisioning.
RecordErrors (list) --
A list of errors that occurred while processing the request.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The text description of the error.
RecordTags (list) --
List of tags associated with this record.
(dict) --
A tag associated with the record, stored as a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
{'ProductViewDetail': {'ProductViewSummary': {'Type': ['MARKETPLACE']}}}
Updates an existing product.
See also: AWS API Documentation
Request Syntax
client.update_product(
AcceptLanguage='string',
Id='string',
Name='string',
Owner='string',
Description='string',
Distributor='string',
SupportDescription='string',
SupportEmail='string',
SupportUrl='string',
AddTags=[
{
'Key': 'string',
'Value': 'string'
},
],
RemoveTags=[
'string',
]
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The identifier of the product for the update request.
string
The updated product name.
string
The updated owner of the product.
string
The updated text description of the product.
string
The updated distributor of the product.
string
The updated support description for the product.
string
The updated support email for the product.
string
The updated support URL for the product.
list
Tags to add to the existing list of tags associated with the product.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) -- [REQUIRED]
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) -- [REQUIRED]
The desired value for this key.
list
Tags to remove from the existing list of tags associated with the product.
(string) --
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
The resulting detailed product view information.
ProductViewSummary (dict) --
The summary metadata about the specified product view.
Id (string) --
The product view identifier.
ProductId (string) --
The product identifier.
Name (string) --
The name of the product.
Owner (string) --
The owner of the product. Contact the product administrator for the significance of this value.
ShortDescription (string) --
Short description of the product.
Type (string) --
The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE , the product was created by AWS Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters .
SupportEmail (string) --
The email contact information to obtain support for this Product.
SupportDescription (string) --
The description of the support for this Product.
SupportUrl (string) --
The URL information to obtain support for this Product.
Status (string) --
Current status of the product.
AVAILABLE - Product is available for use.
CREATING - Creation of product started, not ready for use.
FAILED - Action on product failed.
ProductARN (string) --
The ARN associated with the product.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
Tags (list) --
Tags associated with the product.
(dict) --
Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
Key (string) --
The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters .
Value (string) --
The desired value for this key.
{'RecordDetail': {'Status': ['FAILED', 'IN_PROGRESS_IN_ERROR', 'CREATED']}}
Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.
You can check the status of this request using the DescribeRecord operation.
See also: AWS API Documentation
Request Syntax
client.update_provisioned_product(
AcceptLanguage='string',
ProvisionedProductName='string',
ProvisionedProductId='string',
ProductId='string',
ProvisioningArtifactId='string',
PathId='string',
ProvisioningParameters=[
{
'Key': 'string',
'Value': 'string',
'UsePreviousValue': True|False
},
],
UpdateToken='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
The updated name of the ProvisionedProduct object. Specify either ProvisionedProductName or ProvisionedProductId , but not both.
string
The identifier of the ProvisionedProduct object to update. Specify either ProvisionedProductName or ProvisionedProductId , but not both.
string
The identifier of the ProvisionedProduct object.
string
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
string
The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.
list
A list of ProvisioningParameter objects used to update the ProvisionedProduct object.
(dict) --
The parameter key-value pair used to update a ProvisionedProduct object. If UsePreviousValue is set to true, Value is ignored and the value for Key is kept as previously set (current value).
Key (string) --
The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters .
Value (string) --
The value to use for updating the product provisioning. Any constraints on this value can be found in the ProvisioningArtifactParameter parameter for Key .
UsePreviousValue (boolean) --
If true, uses the currently set value for Key , ignoring UpdateProvisioningParameter.Value .
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'
},
]
}
}
Response Structure
(dict) --
RecordDetail (dict) --
The detailed result of the UpdateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.
RecordId (string) --
The identifier of the ProvisionedProduct object record.
ProvisionedProductName (string) --
The user-friendly name of the ProvisionedProduct object.
Status (string) --
The status of the ProvisionedProduct object.
CREATED - Request created but the operation has not yet 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 roll-back.
SUCCEEDED - The requested operation has successfully completed.
FAILED - The requested operation has completed but has failed. Investigate using the error messages returned.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
UpdatedTime (datetime) --
The time when the record for the ProvisionedProduct object was last updated.
ProvisionedProductType (string) --
The type of the ProvisionedProduct object.
RecordType (string) --
The record type for this record.
ProvisionedProductId (string) --
The identifier of the ProvisionedProduct object.
ProductId (string) --
The product identifier.
ProvisioningArtifactId (string) --
The provisioning artifact identifier for this product. This is sometimes referred to as the product version.
PathId (string) --
The identifier of the path for this product's provisioning.
RecordErrors (list) --
A list of errors that occurred while processing the request.
(dict) --
The error code and description resulting from an operation.
Code (string) --
The numeric value of the error.
Description (string) --
The text description of the error.
RecordTags (list) --
List of tags associated with this record.
(dict) --
A tag associated with the record, stored as a key-value pair.
Key (string) --
The key for this tag.
Value (string) --
The value for this tag.
{'ProvisioningArtifactDetail': {'Type': ['MARKETPLACE_AMI', 'MARKETPLACE_CAR']}}
Updates an existing provisioning artifact's information. This operation does not work on a provisioning artifact associated with a product that has been shared with you.
See also: AWS API Documentation
Request Syntax
client.update_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
Name='string',
Description='string'
)
string
The language code to use for this operation. Supported language codes are as follows:
"en" (English)
"jp" (Japanese)
"zh" (Chinese)
If no code is specified, "en" is used as the default.
string
[REQUIRED]
The product identifier.
string
[REQUIRED]
The identifier of the provisioning artifact for the update request. This is sometimes referred to as the product version.
string
The updated name of the provisioning artifact.
string
The updated text description of the provisioning artifact.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
'CreatedTime': datetime(2015, 1, 1)
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
The resulting detailed provisioning artifact information.
Id (string) --
The identifier of the provisioning artifact. This is sometimes referred to as the product version.
Name (string) --
The name assigned to the provisioning artifact.
Description (string) --
The text description of the provisioning artifact.
Type (string) --
The type of the provisioning artifact. The following provisioning artifact types are used by AWS Marketplace products:
MARKETPLACE_AMI - AMI products.
MARKETPLACE_CAR - CAR (Cluster and AWS Resources) products.
CreatedTime (datetime) --
The UTC timestamp of the creation time.
Info (dict) --
Additional information about the provisioning artifact update request.
(string) --
(string) --
Status (string) --
The status of the current request.