AWS Service Catalog

2023/04/03 - AWS Service Catalog - 3 new 14 updated api methods

Changes  This release introduces Service Catalog support for Terraform open source. It enables 1. The notify* APIs to Service Catalog. These APIs are used by the terraform engine to notify the result of the provisioning engine execution. 2. Adds a new TERRAFORM_OPEN_SOURCE product type in CreateProduct API.

NotifyProvisionProductEngineWorkflowResult (new) Link ¶

Notifies the result of the provisioning engine execution.

See also: AWS API Documentation

Request Syntax

client.notify_provision_product_engine_workflow_result(
    WorkflowToken='string',
    RecordId='string',
    Status='SUCCEEDED'|'FAILED',
    FailureReason='string',
    ResourceIdentifier={
        'UniqueTag': {
            'Key': 'string',
            'Value': 'string'
        }
    },
    Outputs=[
        {
            'OutputKey': 'string',
            'OutputValue': 'string',
            'Description': 'string'
        },
    ],
    IdempotencyToken='string'
)
type WorkflowToken

string

param WorkflowToken

[REQUIRED]

The encrypted contents of the provisioning engine execution payload that Service Catalog sends after the Terraform product provisioning workflow starts.

type RecordId

string

param RecordId

[REQUIRED]

The identifier of the record.

type Status

string

param Status

[REQUIRED]

The status of the provisioning engine execution.

type FailureReason

string

param FailureReason

The reason why the provisioning engine execution failed.

type ResourceIdentifier

dict

param ResourceIdentifier

The ID for the provisioned product resources that are part of a resource group.

  • UniqueTag (dict) --

    The unique key-value pair for a tag that identifies provisioned product resources.

    • Key (string) --

      A unique key that's attached to a resource.

    • Value (string) --

      A unique value that's attached to a resource.

type Outputs

list

param Outputs

The output of the provisioning engine execution.

  • (dict) --

    The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

    • OutputKey (string) --

      The output key.

    • OutputValue (string) --

      The output value.

    • Description (string) --

      The description of the output.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

The idempotency token that identifies the provisioning engine execution.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

NotifyUpdateProvisionedProductEngineWorkflowResult (new) Link ¶

Notifies the result of the update engine execution.

See also: AWS API Documentation

Request Syntax

client.notify_update_provisioned_product_engine_workflow_result(
    WorkflowToken='string',
    RecordId='string',
    Status='SUCCEEDED'|'FAILED',
    FailureReason='string',
    Outputs=[
        {
            'OutputKey': 'string',
            'OutputValue': 'string',
            'Description': 'string'
        },
    ],
    IdempotencyToken='string'
)
type WorkflowToken

string

param WorkflowToken

[REQUIRED]

The encrypted contents of the update engine execution payload that Service Catalog sends after the Terraform product update workflow starts.

type RecordId

string

param RecordId

[REQUIRED]

The identifier of the record.

type Status

string

param Status

[REQUIRED]

The status of the update engine execution.

type FailureReason

string

param FailureReason

The reason why the update engine execution failed.

type Outputs

list

param Outputs

The output of the update engine execution.

  • (dict) --

    The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

    • OutputKey (string) --

      The output key.

    • OutputValue (string) --

      The output value.

    • Description (string) --

      The description of the output.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

The idempotency token that identifies the update engine execution.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

NotifyTerminateProvisionedProductEngineWorkflowResult (new) Link ¶

Notifies the result of the terminate engine execution.

See also: AWS API Documentation

Request Syntax

client.notify_terminate_provisioned_product_engine_workflow_result(
    WorkflowToken='string',
    RecordId='string',
    Status='SUCCEEDED'|'FAILED',
    FailureReason='string',
    IdempotencyToken='string'
)
type WorkflowToken

string

param WorkflowToken

[REQUIRED]

The encrypted contents of the terminate engine execution payload that Service Catalog sends after the Terraform product terminate workflow starts.

type RecordId

string

param RecordId

[REQUIRED]

The identifier of the record.

type Status

string

param Status

[REQUIRED]

The status of the terminate engine execution.

type FailureReason

string

param FailureReason

The reason why the terminate engine execution failed.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

The idempotency token that identifies the terminate engine execution.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

BatchAssociateServiceActionWithProvisioningArtifact (updated) Link ¶
Changes (response)
{'FailedServiceActionAssociations': {'ErrorCode': {'INVALID_PARAMETER'}}}

Associates multiple self-service actions with provisioning artifacts.

See also: AWS API Documentation

Request Syntax

client.batch_associate_service_action_with_provisioning_artifact(
    ServiceActionAssociations=[
        {
            'ServiceActionId': 'string',
            'ProductId': 'string',
            'ProvisioningArtifactId': 'string'
        },
    ],
    AcceptLanguage='string'
)
type ServiceActionAssociations

list

param ServiceActionAssociations

[REQUIRED]

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

  • (dict) --

    A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    • ServiceActionId (string) -- [REQUIRED]

      The self-service action identifier. For example, act-fs7abcd89wxyz .

    • ProductId (string) -- [REQUIRED]

      The product identifier. For example, prod-abcdzk7xy33qa .

    • ProvisioningArtifactId (string) -- [REQUIRED]

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .

type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

rtype

dict

returns

Response Syntax

{
    'FailedServiceActionAssociations': [
        {
            'ServiceActionId': 'string',
            'ProductId': 'string',
            'ProvisioningArtifactId': 'string',
            'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INVALID_PARAMETER',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • FailedServiceActionAssociations (list) --

      An object that contains a list of errors, along with information to help you identify the self-service action.

      • (dict) --

        An object containing information about the error, along with identifying information about the self-service action and its associations.

        • ServiceActionId (string) --

          The self-service action identifier. For example, act-fs7abcd89wxyz .

        • ProductId (string) --

          The product identifier. For example, prod-abcdzk7xy33qa .

        • ProvisioningArtifactId (string) --

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .

        • ErrorCode (string) --

          The error code. Valid values are listed below.

        • ErrorMessage (string) --

          A text description of the error.

BatchDisassociateServiceActionFromProvisioningArtifact (updated) Link ¶
Changes (response)
{'FailedServiceActionAssociations': {'ErrorCode': {'INVALID_PARAMETER'}}}

Disassociates a batch of self-service actions from the specified provisioning artifact.

See also: AWS API Documentation

Request Syntax

client.batch_disassociate_service_action_from_provisioning_artifact(
    ServiceActionAssociations=[
        {
            'ServiceActionId': 'string',
            'ProductId': 'string',
            'ProvisioningArtifactId': 'string'
        },
    ],
    AcceptLanguage='string'
)
type ServiceActionAssociations

list

param ServiceActionAssociations

[REQUIRED]

One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

  • (dict) --

    A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    • ServiceActionId (string) -- [REQUIRED]

      The self-service action identifier. For example, act-fs7abcd89wxyz .

    • ProductId (string) -- [REQUIRED]

      The product identifier. For example, prod-abcdzk7xy33qa .

    • ProvisioningArtifactId (string) -- [REQUIRED]

      The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .

type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

rtype

dict

returns

Response Syntax

{
    'FailedServiceActionAssociations': [
        {
            'ServiceActionId': 'string',
            'ProductId': 'string',
            'ProvisioningArtifactId': 'string',
            'ErrorCode': 'DUPLICATE_RESOURCE'|'INTERNAL_FAILURE'|'LIMIT_EXCEEDED'|'RESOURCE_NOT_FOUND'|'THROTTLING'|'INVALID_PARAMETER',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • FailedServiceActionAssociations (list) --

      An object that contains a list of errors, along with information to help you identify the self-service action.

      • (dict) --

        An object containing information about the error, along with identifying information about the self-service action and its associations.

        • ServiceActionId (string) --

          The self-service action identifier. For example, act-fs7abcd89wxyz .

        • ProductId (string) --

          The product identifier. For example, prod-abcdzk7xy33qa .

        • ProvisioningArtifactId (string) --

          The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne .

        • ErrorCode (string) --

          The error code. Valid values are listed below.

        • ErrorMessage (string) --

          A text description of the error.

CreateProduct (updated) Link ¶
Changes (request, response)
Request
{'ProductType': {'TERRAFORM_OPEN_SOURCE', 'DEFAULT_CUSTOM'},
 'ProvisioningArtifactParameters': {'Type': {'DEFAULT_CUSTOM',
                                             'TERRAFORM_OPEN_SOURCE'}}}
Response
{'ProductViewDetail': {'ProductViewSummary': {'Type': {'DEFAULT_CUSTOM',
                                                       'TERRAFORM_OPEN_SOURCE'}}},
 'ProvisioningArtifactDetail': {'Type': {'DEFAULT_CUSTOM',
                                         'TERRAFORM_OPEN_SOURCE'}}}

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'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ProvisioningArtifactParameters={
        'Name': 'string',
        'Description': 'string',
        'Info': {
            'string': 'string'
        },
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        'DisableTemplateValidation': True|False
    },
    IdempotencyToken='string',
    SourceConnection={
        'Type': 'CODESTAR',
        'ConnectionParameters': {
            'CodeStar': {
                'ConnectionArn': 'string',
                'Repository': 'string',
                'Branch': 'string',
                'ArtifactPath': 'string'
            }
        }
    }
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type Name

string

param Name

[REQUIRED]

The name of the product.

type Owner

string

param Owner

[REQUIRED]

The owner of the product.

type Description

string

param Description

The description of the product.

type Distributor

string

param Distributor

The distributor of the product.

type SupportDescription

string

param SupportDescription

The support information about the product.

type SupportEmail

string

param SupportEmail

The contact email for product support.

type SupportUrl

string

param SupportUrl

The contact URL for product support.

^https?:\/\// / is the pattern used to validate SupportUrl.

type ProductType

string

param ProductType

[REQUIRED]

The type of product.

type Tags

list

param Tags

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.

type ProvisioningArtifactParameters

dict

param ProvisioningArtifactParameters

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

    • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

    • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

  • DisableTemplateValidation (boolean) --

    If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

type IdempotencyToken

string

param IdempotencyToken

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

type SourceConnection

dict

param SourceConnection

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

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
            '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'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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

        • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

        • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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.

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

CreateProvisioningArtifact (updated) Link ¶
Changes (request, response)
Request
{'Parameters': {'Type': {'TERRAFORM_OPEN_SOURCE', 'DEFAULT_CUSTOM'}}}
Response
{'ProvisioningArtifactDetail': {'Type': {'DEFAULT_CUSTOM',
                                         'TERRAFORM_OPEN_SOURCE'}}}

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'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        'DisableTemplateValidation': True|False
    },
    IdempotencyToken='string'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type Parameters

dict

param Parameters

[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

    • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

    • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services Resources

  • DisableTemplateValidation (boolean) --

    If set to true, Service Catalog stops validating the specified provisioning artifact even if it is invalid.

type IdempotencyToken

string

param IdempotencyToken

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

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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

        • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

        • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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.

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

DescribeProduct (updated) Link ¶
Changes (response)
{'ProductViewSummary': {'Type': {'TERRAFORM_OPEN_SOURCE', 'DEFAULT_CUSTOM'}}}

Gets information about the specified product.

Note

Running this operation with administrator access results in a failure. DescribeProductAsAdmin should be used instead.

See also: AWS API Documentation

Request Syntax

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

string

param AcceptLanguage

The language code.

  • 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'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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.

DescribeProductAsAdmin (updated) Link ¶
Changes (response)
{'ProductViewDetail': {'ProductViewSummary': {'Type': {'DEFAULT_CUSTOM',
                                                       'TERRAFORM_OPEN_SOURCE'}}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type Id

string

param Id

The product identifier.

type Name

string

param Name

The product name.

type SourcePortfolioId

string

param SourcePortfolioId

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.

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
            '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.

DescribeProductView (updated) Link ¶
Changes (response)
{'ProductViewSummary': {'Type': {'TERRAFORM_OPEN_SOURCE', 'DEFAULT_CUSTOM'}}}

Gets information about the specified product.

See also: AWS API Documentation

Request Syntax

client.describe_product_view(
    AcceptLanguage='string',
    Id='string'
)
type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type Id

string

param Id

[REQUIRED]

The product view identifier.

rtype

dict

returns

Response Syntax

{
    'ProductViewSummary': {
        'Id': 'string',
        'ProductId': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ShortDescription': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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.

DescribeProvisioningArtifact (updated) Link ¶
Changes (response)
{'ProvisioningArtifactDetail': {'Type': {'DEFAULT_CUSTOM',
                                         'TERRAFORM_OPEN_SOURCE'}}}

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.

  • 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'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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

        • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

        • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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.

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

ListProvisioningArtifacts (updated) Link ¶
Changes (response)
{'ProvisioningArtifactDetails': {'Type': {'DEFAULT_CUSTOM',
                                          'TERRAFORM_OPEN_SOURCE'}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetails': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
            '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

          • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

          • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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.

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

ListProvisioningArtifactsForServiceAction (updated) Link ¶
Changes (response)
{'ProvisioningArtifactViews': {'ProductViewSummary': {'Type': {'DEFAULT_CUSTOM',
                                                               'TERRAFORM_OPEN_SOURCE'}}}}

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

string

param ServiceActionId

[REQUIRED]

The self-service action identifier. For example, act-fs7abcd89wxyz .

type PageSize

integer

param PageSize

The maximum number of items to return with this call.

type PageToken

string

param PageToken

The page token for the next set of results. To retrieve the first set of results, use null.

type AcceptLanguage

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactViews': [
        {
            'ProductViewSummary': {
                'Id': 'string',
                'ProductId': 'string',
                'Name': 'string',
                'Owner': 'string',
                'ShortDescription': 'string',
                'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
                '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.

SearchProducts (updated) Link ¶
Changes (response)
{'ProductViewSummaries': {'Type': {'TERRAFORM_OPEN_SOURCE', 'DEFAULT_CUSTOM'}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type Filters

dict

param Filters

The search filters. If no search filters are specified, the output includes all products to which the caller has access.

  • (string) --

    • (list) --

      • (string) --

type PageSize

integer

param PageSize

The maximum number of items to return with this call.

type SortBy

string

param SortBy

The sort field. If no value is specified, the results are not sorted.

type SortOrder

string

param SortOrder

The sort order. If no value is specified, the results are not sorted.

type PageToken

string

param PageToken

The page token for the next set of results. To retrieve the first set of results, use null.

rtype

dict

returns

Response Syntax

{
    'ProductViewSummaries': [
        {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
            '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.

SearchProductsAsAdmin (updated) Link ¶
Changes (response)
{'ProductViewDetails': {'ProductViewSummary': {'Type': {'DEFAULT_CUSTOM',
                                                        'TERRAFORM_OPEN_SOURCE'}}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type PortfolioId

string

param PortfolioId

The portfolio identifier.

type Filters

dict

param Filters

The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

  • (string) --

    • (list) --

      • (string) --

type SortBy

string

param SortBy

The sort field. If no value is specified, the results are not sorted.

type SortOrder

string

param SortOrder

The sort order. If no value is specified, the results are not sorted.

type PageToken

string

param PageToken

The page token for the next set of results. To retrieve the first set of results, use null.

type PageSize

integer

param PageSize

The maximum number of items to return with this call.

type ProductSource

string

param ProductSource

Access level of the source of the product.

rtype

dict

returns

Response Syntax

{
    'ProductViewDetails': [
        {
            'ProductViewSummary': {
                'Id': 'string',
                'ProductId': 'string',
                'Name': 'string',
                'Owner': 'string',
                'ShortDescription': 'string',
                'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
                '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.

UpdateProduct (updated) Link ¶
Changes (response)
{'ProductViewDetail': {'ProductViewSummary': {'Type': {'DEFAULT_CUSTOM',
                                                       'TERRAFORM_OPEN_SOURCE'}}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type Id

string

param Id

[REQUIRED]

The product identifier.

type Name

string

param Name

The updated product name.

type Owner

string

param Owner

The updated owner of the product.

type Description

string

param Description

The updated description of the product.

type Distributor

string

param Distributor

The updated distributor of the product.

type SupportDescription

string

param SupportDescription

The updated support description for the product.

type SupportEmail

string

param SupportEmail

The updated support email for the product.

type SupportUrl

string

param SupportUrl

The updated support URL for the product.

type AddTags

list

param AddTags

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.

type RemoveTags

list

param RemoveTags

The tags to remove from the product.

  • (string) --

type SourceConnection

dict

param SourceConnection

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

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
            '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.

UpdateProvisioningArtifact (updated) Link ¶
Changes (response)
{'ProvisioningArtifactDetail': {'Type': {'DEFAULT_CUSTOM',
                                         'TERRAFORM_OPEN_SOURCE'}}}

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

string

param AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type ProvisioningArtifactId

string

param ProvisioningArtifactId

[REQUIRED]

The identifier of the provisioning artifact.

type Name

string

param Name

The updated name of the provisioning artifact.

type Description

string

param Description

The updated description of the provisioning artifact.

type Active

boolean

param Active

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.

type Guidance

string

param Guidance

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.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE'|'MARKETPLACE_AMI'|'MARKETPLACE_CAR'|'DEFAULT_CUSTOM'|'TERRAFORM_OPEN_SOURCE',
        '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

        • MARKETPLACE_AMI - Amazon Web Services Marketplace AMI

        • MARKETPLACE_CAR - Amazon Web Services Marketplace Clusters and Amazon Web Services 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.

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