2023/08/08 - AWS Service Catalog - 12 updated api methods
Changes Introduce support for HashiCorp Terraform Cloud in Service Catalog by addying TERRAFORM_CLOUD product type in CreateProduct and CreateProvisioningArtifact API.
{'ProductType': {'TERRAFORM_CLOUD'},
'ProvisioningArtifactParameters': {'Type': {'TERRAFORM_CLOUD'}}}
Response {'ProductViewDetail': {'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}},
'ProvisioningArtifactDetail': {'Type': {'TERRAFORM_CLOUD'}}}
Creates a product.
A delegated admin is authorized to invoke this command.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
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'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ProvisioningArtifactParameters={
'Name': 'string',
'Description': 'string',
'Info': {
'string': 'string'
},
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'DisableTemplateValidation': True|False
},
IdempotencyToken='string',
SourceConnection={
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
}
}
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The name of the product.
string
[REQUIRED]
The owner of the product.
string
The description of the product.
string
The distributor of the product.
string
The support information about the product.
string
The contact email for product support.
string
The contact URL for product support.
``^https?:/// ``/ is the pattern used to validate SupportUrl.
string
[REQUIRED]
The type of product.
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.
dict
The configuration of the provisioning artifact.
Name (string) --
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
Description (string) --
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Info (dict) --
Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
(string) --
(string) --
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
TERRAFORM_OPEN_SOURCE - Terraform open source configuration file
DisableTemplateValidation (boolean) --
If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.
Service Catalog does not support template validation for the TERRAFORM_OS product type.
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
Specifies connection details for the created product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.
Type
ConnectionParamters
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) -- [REQUIRED]
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) -- [REQUIRED]
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) -- [REQUIRED]
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) -- [REQUIRED]
The specific branch where the artifact resides.
ArtifactPath (string) -- [REQUIRED]
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1),
'SourceConnection': {
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
},
'LastSync': {
'LastSyncTime': datetime(2015, 1, 1),
'LastSyncStatus': 'SUCCEEDED'|'FAILED',
'LastSyncStatusMessage': 'string',
'LastSuccessfulSyncTime': datetime(2015, 1, 1),
'LastSuccessfulSyncProvisioningArtifactId': 'string'
}
}
},
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED',
'SourceRevision': 'string'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
The status of the product.
AVAILABLE - The product is ready for use.
CREATING - Product creation has started; the product is not ready for use.
FAILED - An action failed.
ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
SourceConnection (dict) --
A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) --
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) --
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) --
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) --
The specific branch where the artifact resides.
ArtifactPath (string) --
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
LastSync (dict) --
Provides details about the product's connection sync and contains the following sub-fields.
LastSyncTime
LastSyncStatus
LastSyncStatusMessage
LastSuccessfulSyncTime
LastSuccessfulSyncProvisioningArtifactID
LastSyncTime (datetime) --
The time of the last attempted sync from the repository to the Service Catalog product.
LastSyncStatus (string) --
The current status of the sync. Responses include SUCCEEDED or FAILED.
LastSyncStatusMessage (string) --
The sync's status message.
LastSuccessfulSyncTime (datetime) --
The time of the latest successful sync from the source repo artifact to the Service Catalog product.
LastSuccessfulSyncProvisioningArtifactId (string) --
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
SourceRevision (string) --
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.
This field only exists for Repo-Synced products.
Tags (list) --
Information about the tags associated with the product.
(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) --
The tag key.
Value (string) --
The value for this key.
{'Parameters': {'Type': {'TERRAFORM_CLOUD'}}}
Response {'ProvisioningArtifactDetail': {'Type': {'TERRAFORM_CLOUD'}}}
Creates a provisioning artifact (also known as a version) for the specified product.
You cannot create a provisioning artifact for a product that was shared with you.
The user or role that performs this operation must have the cloudformation:GetTemplate IAM policy permission. This policy permission is required when using the ImportFromPhysicalId template source in the information data section.
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'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'DisableTemplateValidation': True|False
},
IdempotencyToken='string'
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The product identifier.
dict
[REQUIRED]
The configuration for the provisioning artifact.
Name (string) --
The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.
Description (string) --
The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
Info (dict) --
Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ]
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format. Specify the URL in JSON format as follows:
"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."
ImportFromPhysicalId: The physical id of the resource that contains the template. Currently only supports CloudFormation stack arn. Specify the physical id in JSON format as follows: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]
(string) --
(string) --
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
TERRAFORM_OPEN_SOURCE - Terraform open source configuration file
DisableTemplateValidation (boolean) --
If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.
Service Catalog does not support template validation for the TERRAFORM_OS product type.
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
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED',
'SourceRevision': 'string'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
SourceRevision (string) --
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.
This field only exists for Repo-Synced products.
Info (dict) --
Specify the template source with one of the following options, but not both. Keys accepted: [ LoadTemplateFromURL, ImportFromPhysicalId ].
Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
LoadTemplateFromURL
Use the URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
ImportFromPhysicalId
Use the physical id of the resource that contains the template; currently supports CloudFormation stack ARN.
(string) --
(string) --
Status (string) --
The status of the current request.
{'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}
Gets information about the specified product.
See also: AWS API Documentation
Request Syntax
client.describe_product(
AcceptLanguage='string',
Id='string',
Name='string'
)
string
The language code.
jp - Japanese
zh - Chinese
string
The product identifier.
string
The product name.
dict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
},
],
'Budgets': [
{
'BudgetName': 'string'
},
],
'LaunchPaths': [
{
'Id': 'string',
'Name': 'string'
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
Information about the provisioning artifacts for the specified product.
(dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
LaunchPaths (list) --
Information about the associated launch paths.
(dict) --
A launch path object.
Id (string) --
The identifier of the launch path.
Name (string) --
The name of the launch path.
{'ProductViewDetail': {'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}}
Gets information about the specified product. This operation is run with administrator access.
See also: AWS API Documentation
Request Syntax
client.describe_product_as_admin(
AcceptLanguage='string',
Id='string',
Name='string',
SourcePortfolioId='string'
)
string
The language code.
jp - Japanese
zh - Chinese
string
The product identifier.
string
The product name.
string
The unique identifier of the shared portfolio that the specified product is associated with.
You can provide this parameter to retrieve the shared TagOptions associated with the product. If this parameter is provided and if TagOptions sharing is enabled in the portfolio share, the API returns both local and shared TagOptions associated with the product. Otherwise only local TagOptions will be returned.
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1),
'SourceConnection': {
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
},
'LastSync': {
'LastSyncTime': datetime(2015, 1, 1),
'LastSyncStatus': 'SUCCEEDED'|'FAILED',
'LastSyncStatusMessage': 'string',
'LastSuccessfulSyncTime': datetime(2015, 1, 1),
'LastSuccessfulSyncProvisioningArtifactId': 'string'
}
}
},
'ProvisioningArtifactSummaries': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'ProvisioningArtifactMetadata': {
'string': 'string'
}
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'TagOptions': [
{
'Key': 'string',
'Value': 'string',
'Active': True|False,
'Id': 'string',
'Owner': 'string'
},
],
'Budgets': [
{
'BudgetName': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
The status of the product.
AVAILABLE - The product is ready for use.
CREATING - Product creation has started; the product is not ready for use.
FAILED - An action failed.
ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
SourceConnection (dict) --
A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) --
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) --
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) --
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) --
The specific branch where the artifact resides.
ArtifactPath (string) --
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
LastSync (dict) --
Provides details about the product's connection sync and contains the following sub-fields.
LastSyncTime
LastSyncStatus
LastSyncStatusMessage
LastSuccessfulSyncTime
LastSuccessfulSyncProvisioningArtifactID
LastSyncTime (datetime) --
The time of the last attempted sync from the repository to the Service Catalog product.
LastSyncStatus (string) --
The current status of the sync. Responses include SUCCEEDED or FAILED.
LastSyncStatusMessage (string) --
The sync's status message.
LastSuccessfulSyncTime (datetime) --
The time of the latest successful sync from the source repo artifact to the Service Catalog product.
LastSuccessfulSyncProvisioningArtifactId (string) --
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.
ProvisioningArtifactSummaries (list) --
Information about the provisioning artifacts (also known as versions) for the specified product.
(dict) --
Summary information about a provisioning artifact (also known as a version) for a product.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
ProvisioningArtifactMetadata (dict) --
The metadata for the provisioning artifact. This is used with Amazon Web Services Marketplace products.
(string) --
(string) --
Tags (list) --
Information about the tags associated with the product.
(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) --
The tag key.
Value (string) --
The value for this key.
TagOptions (list) --
Information about the TagOptions associated with the product.
(dict) --
Information about a TagOption.
Key (string) --
The TagOption key.
Value (string) --
The TagOption value.
Active (boolean) --
The TagOption active state.
Id (string) --
The TagOption identifier.
Owner (string) --
The Amazon Web Services account Id of the owner account that created the TagOption.
Budgets (list) --
Information about the associated budgets.
(dict) --
Information about a budget.
BudgetName (string) --
Name of the associated budget.
{'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}
Gets information about the specified product.
See also: AWS API Documentation
Request Syntax
client.describe_product_view(
AcceptLanguage='string',
Id='string'
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The product view identifier.
dict
Response Syntax
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifacts': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
},
]
}
Response Structure
(dict) --
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
Information about the provisioning artifacts for the product.
(dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
{'ProvisioningArtifactDetail': {'Type': {'TERRAFORM_CLOUD'}}}
Gets information about the specified provisioning artifact (also known as a version) for the specified product.
See also: AWS API Documentation
Request Syntax
client.describe_provisioning_artifact(
AcceptLanguage='string',
ProvisioningArtifactId='string',
ProductId='string',
ProvisioningArtifactName='string',
ProductName='string',
Verbose=True|False,
IncludeProvisioningArtifactParameters=True|False
)
string
The language code.
jp - Japanese
zh - Chinese
string
The identifier of the provisioning artifact.
string
The product identifier.
string
The provisioning artifact name.
string
The product name.
boolean
Indicates whether a verbose level of detail is enabled.
boolean
Indicates if the API call response does or does not include additional details about the provisioning parameters.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED',
'SourceRevision': 'string'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProvisioningArtifactParameters': [
{
'ParameterKey': 'string',
'DefaultValue': 'string',
'ParameterType': 'string',
'IsNoEcho': True|False,
'Description': 'string',
'ParameterConstraints': {
'AllowedValues': [
'string',
],
'AllowedPattern': 'string',
'ConstraintDescription': 'string',
'MaxLength': 'string',
'MinLength': 'string',
'MaxValue': 'string',
'MinValue': 'string'
}
},
]
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
SourceRevision (string) --
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.
This field only exists for Repo-Synced products.
Info (dict) --
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
(string) --
(string) --
Status (string) --
The status of the current request.
ProvisioningArtifactParameters (list) --
Information about the parameters used to provision the product.
(dict) --
Information about a parameter used to provision a product.
ParameterKey (string) --
The parameter key.
DefaultValue (string) --
The default value.
ParameterType (string) --
The parameter type.
IsNoEcho (boolean) --
If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.
Description (string) --
The description of the parameter.
ParameterConstraints (dict) --
Constraints that the administrator has put on a parameter.
AllowedValues (list) --
The values that the administrator has allowed for the parameter.
(string) --
AllowedPattern (string) --
A regular expression that represents the patterns that allow for String types. The pattern must match the entire parameter value provided.
ConstraintDescription (string) --
A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user specifies an invalid value:
Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+
By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:
Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.
MaxLength (string) --
An integer value that determines the largest number of characters you want to allow for String types.
MinLength (string) --
An integer value that determines the smallest number of characters you want to allow for String types.
MaxValue (string) --
A numeric value that determines the largest numeric value you want to allow for Number types.
MinValue (string) --
A numeric value that determines the smallest numeric value you want to allow for Number types.
{'ProvisioningArtifactDetails': {'Type': {'TERRAFORM_CLOUD'}}}
Lists all provisioning artifacts (also known as versions) for the specified product.
See also: AWS API Documentation
Request Syntax
client.list_provisioning_artifacts(
AcceptLanguage='string',
ProductId='string'
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The product identifier.
dict
Response Syntax
{
'ProvisioningArtifactDetails': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED',
'SourceRevision': 'string'
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactDetails (list) --
Information about the provisioning artifacts.
(dict) --
Information about a provisioning artifact (also known as a version) for a product.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
SourceRevision (string) --
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.
This field only exists for Repo-Synced products.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'ProvisioningArtifactViews': {'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}}
Lists all provisioning artifacts (also known as versions) for the specified self-service action.
See also: AWS API Documentation
Request Syntax
client.list_provisioning_artifacts_for_service_action(
ServiceActionId='string',
PageSize=123,
PageToken='string',
AcceptLanguage='string'
)
string
[REQUIRED]
The self-service action identifier. For example, act-fs7abcd89wxyz.
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.
string
The language code.
jp - Japanese
zh - Chinese
dict
Response Syntax
{
'ProvisioningArtifactViews': [
{
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'ProvisioningArtifact': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'Guidance': 'DEFAULT'|'DEPRECATED'
}
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProvisioningArtifactViews (list) --
An array of objects with information about product views and provisioning artifacts.
(dict) --
An object that contains summary information about a product view and a provisioning artifact.
ProductViewSummary (dict) --
Summary information about a 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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.
ProvisioningArtifact (dict) --
Information about a provisioning artifact. A provisioning artifact is also known as a product version.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'ProductViewSummaries': {'Type': {'TERRAFORM_CLOUD'}}}
Gets information about the products to which the caller has access.
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.
jp - Japanese
zh - Chinese
dict
The search filters. If no search filters are specified, the output includes all products to which the caller has access.
(string) --
(list) --
(string) --
integer
The maximum number of items to return with this call.
string
The sort field. If no value is specified, the results are not sorted.
string
The sort order. If no value is specified, the results are not sorted.
string
The page token for the next set of results. To retrieve the first set of results, use null.
dict
Response Syntax
{
'ProductViewSummaries': [
{
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
],
'ProductViewAggregations': {
'string': [
{
'Value': 'string',
'ApproximateCount': 123
},
]
},
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewSummaries (list) --
Information about the product views.
(dict) --
Summary information about a 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
The product view aggregations.
(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 set of results. If there are no additional results, this value is null.
{'ProductViewDetails': {'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}}
Gets information about the products for the specified portfolio or all products.
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.
jp - Japanese
zh - Chinese
string
The portfolio identifier.
dict
The search filters. If no search filters are specified, the output includes all products to which the administrator has access.
(string) --
(list) --
(string) --
string
The sort field. If no value is specified, the results are not sorted.
string
The sort order. If no value is specified, the results are not sorted.
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.
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'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1),
'SourceConnection': {
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
},
'LastSync': {
'LastSyncTime': datetime(2015, 1, 1),
'LastSyncStatus': 'SUCCEEDED'|'FAILED',
'LastSyncStatusMessage': 'string',
'LastSuccessfulSyncTime': datetime(2015, 1, 1),
'LastSuccessfulSyncProvisioningArtifactId': 'string'
}
}
},
],
'NextPageToken': 'string'
}
Response Structure
(dict) --
ProductViewDetails (list) --
Information about the product views.
(dict) --
Information about a product view.
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
The status of the product.
AVAILABLE - The product is ready for use.
CREATING - Product creation has started; the product is not ready for use.
FAILED - An action failed.
ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
SourceConnection (dict) --
A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) --
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) --
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) --
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) --
The specific branch where the artifact resides.
ArtifactPath (string) --
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
LastSync (dict) --
Provides details about the product's connection sync and contains the following sub-fields.
LastSyncTime
LastSyncStatus
LastSyncStatusMessage
LastSuccessfulSyncTime
LastSuccessfulSyncProvisioningArtifactID
LastSyncTime (datetime) --
The time of the last attempted sync from the repository to the Service Catalog product.
LastSyncStatus (string) --
The current status of the sync. Responses include SUCCEEDED or FAILED.
LastSyncStatusMessage (string) --
The sync's status message.
LastSuccessfulSyncTime (datetime) --
The time of the latest successful sync from the source repo artifact to the Service Catalog product.
LastSuccessfulSyncProvisioningArtifactId (string) --
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.
NextPageToken (string) --
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
{'ProductViewDetail': {'ProductViewSummary': {'Type': {'TERRAFORM_CLOUD'}}}}
Updates the specified 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',
],
SourceConnection={
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
}
}
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The product identifier.
string
The updated product name.
string
The updated owner of the product.
string
The updated 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
The tags to add to the product.
(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
The tags to remove from the product.
(string) --
dict
Specifies connection details for the updated product and syncs the product to the connection source artifact. This automatically manages the product's artifacts based on changes to the source. The SourceConnection parameter consists of the following sub-fields.
Type
ConnectionParamters
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) -- [REQUIRED]
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) -- [REQUIRED]
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) -- [REQUIRED]
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) -- [REQUIRED]
The specific branch where the artifact resides.
ArtifactPath (string) -- [REQUIRED]
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
dict
Response Syntax
{
'ProductViewDetail': {
'ProductViewSummary': {
'Id': 'string',
'ProductId': 'string',
'Name': 'string',
'Owner': 'string',
'ShortDescription': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'Distributor': 'string',
'HasDefaultPath': True|False,
'SupportEmail': 'string',
'SupportDescription': 'string',
'SupportUrl': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED',
'ProductARN': 'string',
'CreatedTime': datetime(2015, 1, 1),
'SourceConnection': {
'Type': 'CODESTAR',
'ConnectionParameters': {
'CodeStar': {
'ConnectionArn': 'string',
'Repository': 'string',
'Branch': 'string',
'ArtifactPath': 'string'
}
},
'LastSync': {
'LastSyncTime': datetime(2015, 1, 1),
'LastSyncStatus': 'SUCCEEDED'|'FAILED',
'LastSyncStatusMessage': 'string',
'LastSuccessfulSyncTime': datetime(2015, 1, 1),
'LastSuccessfulSyncProvisioningArtifactId': 'string'
}
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ProductViewDetail (dict) --
Information about the product view.
ProductViewSummary (dict) --
Summary information about the 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 Amazon Web Services Marketplace.
Distributor (string) --
The distributor of the product. Contact the product administrator for the significance of this value.
HasDefaultPath (boolean) --
Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary 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) --
The status of the product.
AVAILABLE - The product is ready for use.
CREATING - Product creation has started; the product is not ready for use.
FAILED - An action failed.
ProductARN (string) --
The ARN of the product.
CreatedTime (datetime) --
The UTC time stamp of the creation time.
SourceConnection (dict) --
A top level ProductViewDetail response containing details about the product’s connection. Service Catalog returns this field for the CreateProduct, UpdateProduct, DescribeProductAsAdmin, and SearchProductAsAdmin APIs. This response contains the same fields as the ConnectionParameters request, with the addition of the LastSync response.
Type (string) --
The only supported SourceConnection type is Codestar.
ConnectionParameters (dict) --
The connection details based on the connection Type.
CodeStar (dict) --
Provides ConnectionType details.
ConnectionArn (string) --
The CodeStar ARN, which is the connection between Service Catalog and the external repository.
Repository (string) --
The specific repository where the product’s artifact-to-be-synced resides, formatted as "Account/Repo."
Branch (string) --
The specific branch where the artifact resides.
ArtifactPath (string) --
The absolute path wehre the artifact resides within the repo and branch, formatted as "folder/file.json."
LastSync (dict) --
Provides details about the product's connection sync and contains the following sub-fields.
LastSyncTime
LastSyncStatus
LastSyncStatusMessage
LastSuccessfulSyncTime
LastSuccessfulSyncProvisioningArtifactID
LastSyncTime (datetime) --
The time of the last attempted sync from the repository to the Service Catalog product.
LastSyncStatus (string) --
The current status of the sync. Responses include SUCCEEDED or FAILED.
LastSyncStatusMessage (string) --
The sync's status message.
LastSuccessfulSyncTime (datetime) --
The time of the latest successful sync from the source repo artifact to the Service Catalog product.
LastSuccessfulSyncProvisioningArtifactId (string) --
The ProvisioningArtifactID of the ProvisioningArtifact created from the latest successful sync.
Tags (list) --
Information about the tags associated with the product.
(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) --
The tag key.
Value (string) --
The value for this key.
{'ProvisioningArtifactDetail': {'Type': {'TERRAFORM_CLOUD'}}}
Updates the specified provisioning artifact (also known as a version) for the specified product.
You cannot update a provisioning artifact for a product that was shared with you.
See also: AWS API Documentation
Request Syntax
client.update_provisioning_artifact(
AcceptLanguage='string',
ProductId='string',
ProvisioningArtifactId='string',
Name='string',
Description='string',
Active=True|False,
Guidance='DEFAULT'|'DEPRECATED'
)
string
The language code.
jp - Japanese
zh - Chinese
string
[REQUIRED]
The product identifier.
string
[REQUIRED]
The identifier of the provisioning artifact.
string
The updated name of the provisioning artifact.
string
The updated description of the provisioning artifact.
boolean
Indicates whether the product version is active.
Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
string
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
The DEFAULT value indicates that the product version is active.
The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.
dict
Response Syntax
{
'ProvisioningArtifactDetail': {
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'TERRAFORM_OPEN_SOURCE'|'TERRAFORM_CLOUD',
'CreatedTime': datetime(2015, 1, 1),
'Active': True|False,
'Guidance': 'DEFAULT'|'DEPRECATED',
'SourceRevision': 'string'
},
'Info': {
'string': 'string'
},
'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}
Response Structure
(dict) --
ProvisioningArtifactDetail (dict) --
Information about the provisioning artifact.
Id (string) --
The identifier of the provisioning artifact.
Name (string) --
The name of the provisioning artifact.
Description (string) --
The description of the provisioning artifact.
Type (string) --
The type of provisioning artifact.
CLOUD_FORMATION_TEMPLATE - CloudFormation template
CreatedTime (datetime) --
The UTC time stamp of the creation time.
Active (boolean) --
Indicates whether the product version is active.
Guidance (string) --
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
SourceRevision (string) --
Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to the existing ProvisioningArtifactDetail type, which is returned as part of the response for CreateProduct, UpdateProduct, DescribeProductAsAdmin, DescribeProvisioningArtifact, ListProvisioningArtifact, and UpdateProvisioningArticat APIs.
This field only exists for Repo-Synced products.
Info (dict) --
The URL of the CloudFormation template in Amazon S3 or GitHub in JSON format.
(string) --
(string) --
Status (string) --
The status of the current request.