AWS Service Catalog

2020/06/05 - AWS Service Catalog - 3 updated api methods

Changes  This release adds support for DescribeProduct and DescribeProductAsAdmin by product name, DescribeProvisioningArtifact by product name or provisioning artifact name, returning launch paths as part of DescribeProduct output and adds maximum length for provisioning artifact name and provisioning artifact description.

DescribeProduct (updated) Link ¶
Changes (request, response)
Request 
{'Name': 'string'}
Response 
{'LaunchPaths': [{'Id': 'string', 'Name': 'string'}]}

Gets information about the specified product.

See also: AWS API Documentation

Request Syntax

client.describe_product(
    AcceptLanguage='string',
    Id='string',
    Name='string'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type Id

string

param Id

The product identifier.

type Name

string

param Name

The product name.

rtype

dict

returns

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),
            '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 AWS 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.

DescribeProductAsAdmin (updated) Link ¶
Changes (request) 
{'Name': 'string'}

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'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type Id

string

param Id

The product identifier.

type Name

string

param Name

The product name.

rtype

dict

returns

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'
        },
    ],
    'TagOptions': [
        {
            'Key': 'string',
            'Value': 'string',
            'Active': True|False,
            'Id': '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 AWS 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.

    • 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 AWS 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.

    • Budgets (list) --

      Information about the associated budgets.

      • (dict) --

        Information about a budget.

        • BudgetName (string) --

          Name of the associated budget.

DescribeProvisioningArtifact (updated) Link ¶
Changes (request) 
{'ProductName': 'string', 'ProvisioningArtifactName': 'string'}

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
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • en - English (default)

  • jp - Japanese

  • zh - Chinese

type ProvisioningArtifactId

string

param ProvisioningArtifactId

The identifier of the provisioning artifact.

type ProductId

string

param ProductId

The product identifier.

type ProvisioningArtifactName

string

param ProvisioningArtifactName

The provisioning artifact name.

type ProductName

string

param ProductName

The product name.

type Verbose

boolean

param Verbose

Indicates whether a verbose level of detail is enabled.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR',
        'CreatedTime': datetime(2015, 1, 1),
        'Active': True|False,
        'Guidance': 'DEFAULT'|'DEPRECATED'
    },
    '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 - AWS CloudFormation template

        • MARKETPLACE_AMI - AWS Marketplace AMI

        • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

      • 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.

    • Info (dict) --

      The URL of the CloudFormation template in Amazon S3.

      • (string) --

        • (string) --

    • Status (string) --

      The status of the current request.