AWS API Changes

2016/11/16 - AWS Service Catalog - 32 new 3 updated api methods

Changes This release enables Service Catalog users to perform administer operations via API.

DescribeConstraint (new)

Retrieves detailed information for a specified constraint.

Request Syntax

client.describe_constraint(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the constraint.

rtype

dict

returns

Response Syntax

{
    'ConstraintDetail': {
        'ConstraintId': 'string',
        'Type': 'string',
        'Description': 'string',
        'Owner': 'string'
    },
    'ConstraintParameters': 'string',
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ConstraintDetail (dict) --
  
  Detailed constraint information.
  - ConstraintId (string) --
    
    The identifier of the constraint.
  - Type (string) --
    
    The type of the constraint.
  - Description (string) --
    
    The text description of the constraint.
  - Owner (string) --
    
    The owner of the constraint.
- ConstraintParameters (string) --
  
  The current parameters associated with the specified constraint.
- Status (string) --
  
  The status of the current request.

DisassociatePrincipalFromPortfolio (new)

Link ¶

Disassociates a previously associated principal ARN from a specified portfolio.

Request Syntax

client.disassociate_principal_from_portfolio(
    AcceptLanguage='string',
    PortfolioId='string',
    PrincipalARN='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type PrincipalARN

string

param PrincipalARN

[REQUIRED]

The ARN representing the principal (IAM user, role, or group).

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateProvisioningArtifact (new)

Link ¶

Create a new provisioning artifact for the specified product. This operation will not work with a product that has been shared with you.

Request Syntax

client.create_provisioning_artifact(
    AcceptLanguage='string',
    ProductId='string',
    Parameters={
        'Name': 'string',
        'Description': 'string',
        'Info': {
            'string': 'string'
        },
        'Type': 'CLOUD_FORMATION_TEMPLATE'
    },
    IdempotencyToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type Parameters

dict

param Parameters

[REQUIRED]

The parameters to use when creating the new provisioning artifact.

Name (string) --

The name assigned to the provisioning artifact properties.
Description (string) --

The text description of the provisioning artifact properties.
Info (dict) -- [REQUIRED]

Additional information about the provisioning artifact properties.
- (string) --
  - (string) --
Type (string) --

The type of the provisioning artifact properties.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Info': {
        'string': 'string'
    },
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ProvisioningArtifactDetail (dict) --
  
  The resulting detailed provisioning artifact information.
  - Id (string) --
    
    The identifier of the provisioning artifact.
  - Name (string) --
    
    The name assigned to the provisioning artifact.
  - Description (string) --
    
    The text description of the provisioning artifact.
  - Type (string) --
    
    The type of the provisioning artifact.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Info (dict) --
  
  Additional information about the provisioning artifact create request.
  - (string) --
    - (string) --
- Status (string) --
  
  The status of the current request.

AssociateProductWithPortfolio (new)

Link ¶

Associates a product with a portfolio.

Request Syntax

client.associate_product_with_portfolio(
    AcceptLanguage='string',
    ProductId='string',
    PortfolioId='string',
    SourcePortfolioId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type SourcePortfolioId

string

param SourcePortfolioId

The identifier of the source portfolio to use with this association.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateProduct (new)

Link ¶

Updates an existing product.

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',
    ]
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the product for the update request.

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 text 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

Tags to add to the existing list of tags associated with the product.

(dict) --

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
- Key (string) -- [REQUIRED]
  
  The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
- Value (string) -- [REQUIRED]
  
  The esired value for this key.

type RemoveTags

list

param RemoveTags

Tags to remove from the existing list of tags associated with the product.

(string) --

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE',
            'Distributor': 'string',
            'HasDefaultPath': True|False,
            'SupportEmail': 'string',
            'SupportDescription': 'string',
            'SupportUrl': 'string'
        },
        'Status': 'AVAILABLE'|'CREATING'|'FAILED',
        'ProductARN': 'string',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- ProductViewDetail (dict) --
  
  The resulting detailed product view information.
  - ProductViewSummary (dict) --
    
    The summary metadata about the specified product view.
    - Id (string) --
      
      The product view identifier.
    - ProductId (string) --
      
      The product identifier.
    - Name (string) --
      
      The name of the product.
    - Owner (string) --
      
      The owner of the product. Contact the product administrator for the significance of this value.
    - ShortDescription (string) --
      
      Short description of the product.
    - Type (string) --
      
      The product type. Contact the product administrator for the significance of this value.
    - Distributor (string) --
      
      The distributor of the product. Contact the product administrator for the significance of this value.
    - HasDefaultPath (boolean) --
      
      A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
    - SupportEmail (string) --
      
      The email contact information to obtain support for this Product.
    - SupportDescription (string) --
      
      The description of the support for this Product.
    - SupportUrl (string) --
      
      The URL information to obtain support for this Product.
  - Status (string) --
    
    Current status of the product.
  - ProductARN (string) --
    
    The ARN associated with the product.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Tags (list) --
  
  Tags associated with the product.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

DeletePortfolio (new)

Link ¶

Deletes the specified portfolio. This operation will not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

Request Syntax

client.delete_portfolio(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the portfolio for the delete request.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteProduct (new)

Link ¶

Deletes the specified product. This operation will not work with a product that has been shared with you or is associated with a portfolio.

Request Syntax

client.delete_product(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the product for the delete request.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

UpdateConstraint (new)

Link ¶

Updates an existing constraint.

Request Syntax

client.update_constraint(
    AcceptLanguage='string',
    Id='string',
    Description='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the constraint to update.

type Description

string

param Description

The updated text description of the constraint.

rtype

dict

returns

Response Syntax

{
    'ConstraintDetail': {
        'ConstraintId': 'string',
        'Type': 'string',
        'Description': 'string',
        'Owner': 'string'
    },
    'ConstraintParameters': 'string',
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ConstraintDetail (dict) --
  
  The resulting detailed constraint information.
  - ConstraintId (string) --
    
    The identifier of the constraint.
  - Type (string) --
    
    The type of the constraint.
  - Description (string) --
    
    The text description of the constraint.
  - Owner (string) --
    
    The owner of the constraint.
- ConstraintParameters (string) --
  
  The resulting updated constraint parameters.
- Status (string) --
  
  The status of the current request.

UpdatePortfolio (new)

Link ¶

Updates the specified portfolio's details. This operation will not work with a product that has been shared with you.

Request Syntax

client.update_portfolio(
    AcceptLanguage='string',
    Id='string',
    DisplayName='string',
    Description='string',
    ProviderName='string',
    AddTags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    RemoveTags=[
        'string',
    ]
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the portfolio for the update request.

type DisplayName

string

param DisplayName

The name to use for display purposes.

type Description

string

param Description

The updated text description of the portfolio.

type ProviderName

string

param ProviderName

The updated name of the portfolio provider.

type AddTags

list

param AddTags

Tags to add to the existing list of tags associated with the portfolio.

(dict) --

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
- Key (string) -- [REQUIRED]
  
  The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
- Value (string) -- [REQUIRED]
  
  The esired value for this key.

type RemoveTags

list

param RemoveTags

Tags to remove from the existing list of tags associated with the portfolio.

(string) --

rtype

dict

returns

Response Syntax

{
    'PortfolioDetail': {
        'Id': 'string',
        'ARN': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ProviderName': 'string'
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- PortfolioDetail (dict) --
  
  The resulting detailed portfolio information.
  - Id (string) --
    
    The identifier for the portfolio.
  - ARN (string) --
    
    The ARN assigned to the portfolio.
  - DisplayName (string) --
    
    The name to use for display purposes.
  - Description (string) --
    
    The text description of the portfolio.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
  - ProviderName (string) --
    
    The name of the portfolio provider.
- Tags (list) --
  
  Tags associated with the portfolio.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

ListProvisioningArtifacts (new)

Link ¶

Lists all provisioning artifacts associated with the specified product.

Request Syntax

client.list_provisioning_artifacts(
    AcceptLanguage='string',
    ProductId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

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',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- ProvisioningArtifactDetails (list) --
  
  List of detailed provisioning artifact information objects.
  - (dict) --
    
    Detailed provisioning artifact information.
    - Id (string) --
      
      The identifier of the provisioning artifact.
    - Name (string) --
      
      The name assigned to the provisioning artifact.
    - Description (string) --
      
      The text description of the provisioning artifact.
    - Type (string) --
      
      The type of the provisioning artifact.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

DescribePortfolio (new)

Link ¶

Retrieves detailed information and any tags associated with the specified portfolio.

Request Syntax

client.describe_portfolio(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the portfolio for which to retrieve information.

rtype

dict

returns

Response Syntax

{
    'PortfolioDetail': {
        'Id': 'string',
        'ARN': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ProviderName': 'string'
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- PortfolioDetail (dict) --
  
  Detailed portfolio information.
  - Id (string) --
    
    The identifier for the portfolio.
  - ARN (string) --
    
    The ARN assigned to the portfolio.
  - DisplayName (string) --
    
    The name to use for display purposes.
  - Description (string) --
    
    The text description of the portfolio.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
  - ProviderName (string) --
    
    The name of the portfolio provider.
- Tags (list) --
  
  Tags associated with the portfolio.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

DisassociateProductFromPortfolio (new)

Link ¶

Disassociates the specified product from the specified portfolio.

Request Syntax

client.disassociate_product_from_portfolio(
    AcceptLanguage='string',
    ProductId='string',
    PortfolioId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListAcceptedPortfolioShares (new)

Link ¶

Lists details of all portfolios for which sharing was accepted by this account.

Request Syntax

client.list_accepted_portfolio_shares(
    AcceptLanguage='string',
    PageToken='string',
    PageSize=123
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

rtype

dict

returns

Response Syntax

{
    'PortfolioDetails': [
        {
            'Id': 'string',
            'ARN': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ProviderName': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- PortfolioDetails (list) --
  
  List of detailed portfolio information objects.
  - (dict) --
    
    Detailed portfolio information.
    - Id (string) --
      
      The identifier for the portfolio.
    - ARN (string) --
      
      The ARN assigned to the portfolio.
    - DisplayName (string) --
      
      The name to use for display purposes.
    - Description (string) --
      
      The text description of the portfolio.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.
    - ProviderName (string) --
      
      The name of the portfolio provider.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ListPrincipalsForPortfolio (new)

Link ¶

Lists all principal ARNs associated with the specified portfolio.

Request Syntax

client.list_principals_for_portfolio(
    AcceptLanguage='string',
    PortfolioId='string',
    PageSize=123,
    PageToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

rtype

dict

returns

Response Syntax

{
    'Principals': [
        {
            'PrincipalARN': 'string',
            'PrincipalType': 'IAM'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- Principals (list) --
  
  The IAM principals (users or roles) associated with the portfolio.
  - (dict) --
    
    A principal's ARN and type.
    - PrincipalARN (string) --
      
      The ARN representing the principal (IAM user, role, or group).
    - PrincipalType (string) --
      
      The principal type. Must be IAM
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

DescribeProductAsAdmin (new)

Link ¶

Retrieves information about a specified product, run with administrator access.

Request Syntax

client.describe_product_as_admin(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the product for which to retrieve information.

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE',
            'Distributor': 'string',
            'HasDefaultPath': True|False,
            'SupportEmail': 'string',
            'SupportDescription': 'string',
            'SupportUrl': 'string'
        },
        'Status': 'AVAILABLE'|'CREATING'|'FAILED',
        'ProductARN': 'string',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- ProductViewDetail (dict) --
  
  Detailed product view information.
  - ProductViewSummary (dict) --
    
    The summary metadata about the specified product view.
    - Id (string) --
      
      The product view identifier.
    - ProductId (string) --
      
      The product identifier.
    - Name (string) --
      
      The name of the product.
    - Owner (string) --
      
      The owner of the product. Contact the product administrator for the significance of this value.
    - ShortDescription (string) --
      
      Short description of the product.
    - Type (string) --
      
      The product type. Contact the product administrator for the significance of this value.
    - Distributor (string) --
      
      The distributor of the product. Contact the product administrator for the significance of this value.
    - HasDefaultPath (boolean) --
      
      A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
    - SupportEmail (string) --
      
      The email contact information to obtain support for this Product.
    - SupportDescription (string) --
      
      The description of the support for this Product.
    - SupportUrl (string) --
      
      The URL information to obtain support for this Product.
  - Status (string) --
    
    Current status of the product.
  - ProductARN (string) --
    
    The ARN associated with the product.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Tags (list) --
  
  Tags associated with the product.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

AcceptPortfolioShare (new)

Link ¶

Accepts an offer to share a portfolio.

Request Syntax

client.accept_portfolio_share(
    AcceptLanguage='string',
    PortfolioId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeletePortfolioShare (new)

Link ¶

Deletes the specified portfolio share.

Request Syntax

client.delete_portfolio_share(
    AcceptLanguage='string',
    PortfolioId='string',
    AccountId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type AccountId

string

param AccountId

[REQUIRED]

The account ID associated with the share to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DeleteConstraint (new)

Link ¶

Deletes the specified constraint.

Request Syntax

client.delete_constraint(
    AcceptLanguage='string',
    Id='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The identifier of the constraint to delete.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListPortfolioAccess (new)

Link ¶

Lists the account IDs that have been authorized sharing of the specified portfolio.

Request Syntax

client.list_portfolio_access(
    AcceptLanguage='string',
    PortfolioId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

rtype

dict

returns

Response Syntax

{
    'AccountIds': [
        'string',
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- AccountIds (list) --
  
  List of account IDs associated with access to the portfolio.
  - (string) --
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ListPortfolios (new)

Link ¶

Lists all portfolios in the catalog.

Request Syntax

client.list_portfolios(
    AcceptLanguage='string',
    PageToken='string',
    PageSize=123
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

rtype

dict

returns

Response Syntax

{
    'PortfolioDetails': [
        {
            'Id': 'string',
            'ARN': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ProviderName': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- PortfolioDetails (list) --
  
  List of detailed portfolio information objects.
  - (dict) --
    
    Detailed portfolio information.
    - Id (string) --
      
      The identifier for the portfolio.
    - ARN (string) --
      
      The ARN assigned to the portfolio.
    - DisplayName (string) --
      
      The name to use for display purposes.
    - Description (string) --
      
      The text description of the portfolio.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.
    - ProviderName (string) --
      
      The name of the portfolio provider.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

UpdateProvisioningArtifact (new)

Link ¶

Updates an existing provisioning artifact's information. This operation will not work on a provisioning artifact associated with a product that has been shared with you.

Request Syntax

client.update_provisioning_artifact(
    AcceptLanguage='string',
    ProductId='string',
    ProvisioningArtifactId='string',
    Name='string',
    Description='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type ProvisioningArtifactId

string

param ProvisioningArtifactId

[REQUIRED]

The identifier of the provisioning artifact for the update request.

type Name

string

param Name

The updated name of the provisioning artifact.

type Description

string

param Description

The updated text description of the provisioning artifact.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Info': {
        'string': 'string'
    },
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ProvisioningArtifactDetail (dict) --
  
  The resulting detailed provisioning artifact information.
  - Id (string) --
    
    The identifier of the provisioning artifact.
  - Name (string) --
    
    The name assigned to the provisioning artifact.
  - Description (string) --
    
    The text description of the provisioning artifact.
  - Type (string) --
    
    The type of the provisioning artifact.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Info (dict) --
  
  Additional information about the provisioning artifact update request.
  - (string) --
    - (string) --
- Status (string) --
  
  The status of the current request.

DeleteProvisioningArtifact (new)

Link ¶

Deletes the specified provisioning artifact. This operation will not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).

Request Syntax

client.delete_provisioning_artifact(
    AcceptLanguage='string',
    ProductId='string',
    ProvisioningArtifactId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type ProvisioningArtifactId

string

param ProvisioningArtifactId

[REQUIRED]

The identifier of the provisioning artifact for the delete request.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

DescribeProvisioningArtifact (new)

Link ¶

Retrieves detailed information about the specified provisioning artifact.

Request Syntax

client.describe_provisioning_artifact(
    AcceptLanguage='string',
    ProvisioningArtifactId='string',
    ProductId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProvisioningArtifactId

string

param ProvisioningArtifactId

[REQUIRED]

The identifier of the provisioning artifact.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

rtype

dict

returns

Response Syntax

{
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Info': {
        'string': 'string'
    },
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ProvisioningArtifactDetail (dict) --
  
  Detailed provisioning artifact information.
  - Id (string) --
    
    The identifier of the provisioning artifact.
  - Name (string) --
    
    The name assigned to the provisioning artifact.
  - Description (string) --
    
    The text description of the provisioning artifact.
  - Type (string) --
    
    The type of the provisioning artifact.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Info (dict) --
  
  Additional information about the provisioning artifact.
  - (string) --
    - (string) --
- Status (string) --
  
  The status of the current request.

CreateConstraint (new)

Link ¶

Creates a new constraint.

Request Syntax

client.create_constraint(
    AcceptLanguage='string',
    PortfolioId='string',
    ProductId='string',
    Parameters='string',
    Type='string',
    Description='string',
    IdempotencyToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type Parameters

string

param Parameters

[REQUIRED]

The constraint parameters.

type Type

string

param Type

[REQUIRED]

The type of the constraint.

type Description

string

param Description

The text description of the constraint.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ConstraintDetail': {
        'ConstraintId': 'string',
        'Type': 'string',
        'Description': 'string',
        'Owner': 'string'
    },
    'ConstraintParameters': 'string',
    'Status': 'AVAILABLE'|'CREATING'|'FAILED'
}

Response Structure

(dict) --
- ConstraintDetail (dict) --
  
  The resulting detailed constraint information.
  - ConstraintId (string) --
    
    The identifier of the constraint.
  - Type (string) --
    
    The type of the constraint.
  - Description (string) --
    
    The text description of the constraint.
  - Owner (string) --
    
    The owner of the constraint.
- ConstraintParameters (string) --
  
  The resulting constraint parameters.
- Status (string) --
  
  The status of the current request.

CreatePortfolioShare (new)

Link ¶

Creates a new portfolio share.

Request Syntax

client.create_portfolio_share(
    AcceptLanguage='string',
    PortfolioId='string',
    AccountId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type AccountId

string

param AccountId

[REQUIRED]

The account ID with which to share the portfolio.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

RejectPortfolioShare (new)

Link ¶

Rejects an offer to share a portfolio.

Request Syntax

client.reject_portfolio_share(
    AcceptLanguage='string',
    PortfolioId='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListConstraintsForPortfolio (new)

Link ¶

Retrieves detailed constraint information for the specified portfolio and product.

Request Syntax

client.list_constraints_for_portfolio(
    AcceptLanguage='string',
    PortfolioId='string',
    ProductId='string',
    PageSize=123,
    PageToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type ProductId

string

param ProductId

The product identifier.

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

rtype

dict

returns

Response Syntax

{
    'ConstraintDetails': [
        {
            'ConstraintId': 'string',
            'Type': 'string',
            'Description': 'string',
            'Owner': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- ConstraintDetails (list) --
  
  List of detailed constraint information objects.
  - (dict) --
    
    Detailed constraint information.
    - ConstraintId (string) --
      
      The identifier of the constraint.
    - Type (string) --
      
      The type of the constraint.
    - Description (string) --
      
      The text description of the constraint.
    - Owner (string) --
      
      The owner of the constraint.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

ListPortfoliosForProduct (new)

Link ¶

Lists all portfolios that the specified product is associated with.

Request Syntax

client.list_portfolios_for_product(
    AcceptLanguage='string',
    ProductId='string',
    PageToken='string',
    PageSize=123
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type ProductId

string

param ProductId

[REQUIRED]

The product identifier.

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

rtype

dict

returns

Response Syntax

{
    'PortfolioDetails': [
        {
            'Id': 'string',
            'ARN': 'string',
            'DisplayName': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'ProviderName': 'string'
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- PortfolioDetails (list) --
  
  List of detailed portfolio information objects.
  - (dict) --
    
    Detailed portfolio information.
    - Id (string) --
      
      The identifier for the portfolio.
    - ARN (string) --
      
      The ARN assigned to the portfolio.
    - DisplayName (string) --
      
      The name to use for display purposes.
    - Description (string) --
      
      The text description of the portfolio.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.
    - ProviderName (string) --
      
      The name of the portfolio provider.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

CreateProduct (new)

Link ¶

Creates a new product.

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',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ProvisioningArtifactParameters={
        'Name': 'string',
        'Description': 'string',
        'Info': {
            'string': 'string'
        },
        'Type': 'CLOUD_FORMATION_TEMPLATE'
    },
    IdempotencyToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

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 text description of the product.

type Distributor

string

param Distributor

The distributor of the product.

type SupportDescription

string

param SupportDescription

Support information about the product.

type SupportEmail

string

param SupportEmail

Contact email for product support.

type SupportUrl

string

param SupportUrl

Contact URL for product support.

type ProductType

string

param ProductType

[REQUIRED]

The type of the product to create.

type Tags

list

param Tags

Tags to associate with the new product.

(dict) --

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
- Key (string) -- [REQUIRED]
  
  The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
- Value (string) -- [REQUIRED]
  
  The esired value for this key.

type ProvisioningArtifactParameters

dict

param ProvisioningArtifactParameters

[REQUIRED]

Parameters for the provisioning artifact.

Name (string) --

The name assigned to the provisioning artifact properties.
Description (string) --

The text description of the provisioning artifact properties.
Info (dict) -- [REQUIRED]

Additional information about the provisioning artifact properties.
- (string) --
  - (string) --
Type (string) --

The type of the provisioning artifact properties.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'ProductViewDetail': {
        'ProductViewSummary': {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE',
            'Distributor': 'string',
            'HasDefaultPath': True|False,
            'SupportEmail': 'string',
            'SupportDescription': 'string',
            'SupportUrl': 'string'
        },
        'Status': 'AVAILABLE'|'CREATING'|'FAILED',
        'ProductARN': 'string',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'ProvisioningArtifactDetail': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'CreatedTime': datetime(2015, 1, 1)
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- ProductViewDetail (dict) --
  
  The resulting detailed product view information.
  - ProductViewSummary (dict) --
    
    The summary metadata about the specified product view.
    - Id (string) --
      
      The product view identifier.
    - ProductId (string) --
      
      The product identifier.
    - Name (string) --
      
      The name of the product.
    - Owner (string) --
      
      The owner of the product. Contact the product administrator for the significance of this value.
    - ShortDescription (string) --
      
      Short description of the product.
    - Type (string) --
      
      The product type. Contact the product administrator for the significance of this value.
    - Distributor (string) --
      
      The distributor of the product. Contact the product administrator for the significance of this value.
    - HasDefaultPath (boolean) --
      
      A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
    - SupportEmail (string) --
      
      The email contact information to obtain support for this Product.
    - SupportDescription (string) --
      
      The description of the support for this Product.
    - SupportUrl (string) --
      
      The URL information to obtain support for this Product.
  - Status (string) --
    
    Current status of the product.
  - ProductARN (string) --
    
    The ARN associated with the product.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- ProvisioningArtifactDetail (dict) --
  
  The resulting detailed provisioning artifact information.
  - Id (string) --
    
    The identifier of the provisioning artifact.
  - Name (string) --
    
    The name assigned to the provisioning artifact.
  - Description (string) --
    
    The text description of the provisioning artifact.
  - Type (string) --
    
    The type of the provisioning artifact.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
- Tags (list) --
  
  Tags successfully associated with the new product.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

AssociatePrincipalWithPortfolio (new)

Link ¶

Associates the specified principal ARN with the specified portfolio.

Request Syntax

client.associate_principal_with_portfolio(
    AcceptLanguage='string',
    PortfolioId='string',
    PrincipalARN='string',
    PrincipalType='IAM'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

[REQUIRED]

The portfolio identifier.

type PrincipalARN

string

param PrincipalARN

[REQUIRED]

The ARN representing the principal (IAM user, role, or group).

type PrincipalType

string

param PrincipalType

[REQUIRED]

The principal type. Must be IAM

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreatePortfolio (new)

Link ¶

Creates a new portfolio.

Request Syntax

client.create_portfolio(
    AcceptLanguage='string',
    DisplayName='string',
    Description='string',
    ProviderName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IdempotencyToken='string'
)

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type DisplayName

string

param DisplayName

[REQUIRED]

The name to use for display purposes.

type Description

string

param Description

The text description of the portfolio.

type ProviderName

string

param ProviderName

[REQUIRED]

The name of the portfolio provider.

type Tags

list

param Tags

Tags to associate with the new portfolio.

(dict) --

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
- Key (string) -- [REQUIRED]
  
  The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
- Value (string) -- [REQUIRED]
  
  The esired value for this key.

type IdempotencyToken

string

param IdempotencyToken

[REQUIRED]

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'PortfolioDetail': {
        'Id': 'string',
        'ARN': 'string',
        'DisplayName': 'string',
        'Description': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'ProviderName': 'string'
    },
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- PortfolioDetail (dict) --
  
  The resulting detailed portfolio information.
  - Id (string) --
    
    The identifier for the portfolio.
  - ARN (string) --
    
    The ARN assigned to the portfolio.
  - DisplayName (string) --
    
    The name to use for display purposes.
  - Description (string) --
    
    The text description of the portfolio.
  - CreatedTime (datetime) --
    
    The UTC timestamp of the creation time.
  - ProviderName (string) --
    
    The name of the portfolio provider.
- Tags (list) --
  
  Tags successfully associated with the new portfolio.
  - (dict) --
    
    Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.
    - Key (string) --
      
      The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.
    - Value (string) --
      
      The esired value for this key.

SearchProductsAsAdmin (new)

Link ¶

Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

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 to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type PortfolioId

string

param PortfolioId

The portfolio identifier.

type Filters

dict

param Filters

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.

(string) --
- (list) --
  - (string) --

type SortBy

string

param SortBy

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

type SortOrder

string

param SortOrder

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

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

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',
                'Distributor': 'string',
                'HasDefaultPath': True|False,
                'SupportEmail': 'string',
                'SupportDescription': 'string',
                'SupportUrl': 'string'
            },
            'Status': 'AVAILABLE'|'CREATING'|'FAILED',
            'ProductARN': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ],
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- ProductViewDetails (list) --
  
  List of detailed product view information objects.
  - (dict) --
    
    Detailed product view information.
    - ProductViewSummary (dict) --
      
      The summary metadata about the specified product view.
      - Id (string) --
        
        The product view identifier.
      - ProductId (string) --
        
        The product identifier.
      - Name (string) --
        
        The name of the product.
      - Owner (string) --
        
        The owner of the product. Contact the product administrator for the significance of this value.
      - ShortDescription (string) --
        
        Short description of the product.
      - Type (string) --
        
        The product type. Contact the product administrator for the significance of this value.
      - Distributor (string) --
        
        The distributor of the product. Contact the product administrator for the significance of this value.
      - HasDefaultPath (boolean) --
        
        A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
      - SupportEmail (string) --
        
        The email contact information to obtain support for this Product.
      - SupportDescription (string) --
        
        The description of the support for this Product.
      - SupportUrl (string) --
        
        The URL information to obtain support for this Product.
    - Status (string) --
      
      Current status of the product.
    - ProductARN (string) --
      
      The ARN associated with the product.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

DescribeProduct (updated)

Link ¶
Changes (response)

{'ProductViewSummary': {'Type': {'CLOUD_FORMATION_TEMPLATE'}}}

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId .

Request Syntax

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

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The ProductId of the product to describe.

rtype

dict

returns

Response Syntax

{
    'ProductViewSummary': {
        'Id': 'string',
        'ProductId': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ShortDescription': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'Distributor': 'string',
        'HasDefaultPath': True|False,
        'SupportEmail': 'string',
        'SupportDescription': 'string',
        'SupportUrl': 'string'
    },
    'ProvisioningArtifacts': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- ProductViewSummary (dict) --
  
  The summary metadata about the specified product.
  - Id (string) --
    
    The product view identifier.
  - ProductId (string) --
    
    The product identifier.
  - Name (string) --
    
    The name of the product.
  - Owner (string) --
    
    The owner of the product. Contact the product administrator for the significance of this value.
  - ShortDescription (string) --
    
    Short description of the product.
  - Type (string) --
    
    The product type. Contact the product administrator for the significance of this value.
  - Distributor (string) --
    
    The distributor of the product. Contact the product administrator for the significance of this value.
  - HasDefaultPath (boolean) --
    
    A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
  - SupportEmail (string) --
    
    The email contact information to obtain support for this Product.
  - SupportDescription (string) --
    
    The description of the support for this Product.
  - SupportUrl (string) --
    
    The URL information to obtain support for this Product.
- ProvisioningArtifacts (list) --
  
  A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts parameter represent the ways the specified product can be provisioned.
  - (dict) --
    
    Contains information indicating the ways in which a product can be provisioned.
    - Id (string) --
      
      The identifier for the artifact.
    - Name (string) --
      
      The name of the artifact.
    - Description (string) --
      
      The text description of the artifact.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.

DescribeProductView (updated)

Link ¶
Changes (response)

{'ProductViewSummary': {'Type': {'CLOUD_FORMATION_TEMPLATE'}}}

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId .

Request Syntax

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

type AcceptLanguage

string

param AcceptLanguage

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Id

string

param Id

[REQUIRED]

The ProductViewId of the product to describe.

rtype

dict

returns

Response Syntax

{
    'ProductViewSummary': {
        'Id': 'string',
        'ProductId': 'string',
        'Name': 'string',
        'Owner': 'string',
        'ShortDescription': 'string',
        'Type': 'CLOUD_FORMATION_TEMPLATE',
        'Distributor': 'string',
        'HasDefaultPath': True|False,
        'SupportEmail': 'string',
        'SupportDescription': 'string',
        'SupportUrl': 'string'
    },
    'ProvisioningArtifacts': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) --
- ProductViewSummary (dict) --
  
  The summary metadata about the specified product.
  - Id (string) --
    
    The product view identifier.
  - ProductId (string) --
    
    The product identifier.
  - Name (string) --
    
    The name of the product.
  - Owner (string) --
    
    The owner of the product. Contact the product administrator for the significance of this value.
  - ShortDescription (string) --
    
    Short description of the product.
  - Type (string) --
    
    The product type. Contact the product administrator for the significance of this value.
  - Distributor (string) --
    
    The distributor of the product. Contact the product administrator for the significance of this value.
  - HasDefaultPath (boolean) --
    
    A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
  - SupportEmail (string) --
    
    The email contact information to obtain support for this Product.
  - SupportDescription (string) --
    
    The description of the support for this Product.
  - SupportUrl (string) --
    
    The URL information to obtain support for this Product.
- ProvisioningArtifacts (list) --
  
  A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts represent the ways in which the specified product can be provisioned.
  - (dict) --
    
    Contains information indicating the ways in which a product can be provisioned.
    - Id (string) --
      
      The identifier for the artifact.
    - Name (string) --
      
      The name of the artifact.
    - Description (string) --
      
      The text description of the artifact.
    - CreatedTime (datetime) --
      
      The UTC timestamp of the creation time.

SearchProducts (updated)

Link ¶
Changes (response)

{'ProductViewSummaries': {'Type': {'CLOUD_FORMATION_TEMPLATE'}}}

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

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 to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

type Filters

dict

param Filters

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.

(string) --
- (list) --
  - (string) --

type PageSize

integer

param PageSize

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize , the value of NextPageToken in the response is non-null.

type SortBy

string

param SortBy

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

type SortOrder

string

param SortOrder

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

type PageToken

string

param PageToken

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize .

rtype

dict

returns

Response Syntax

{
    'ProductViewSummaries': [
        {
            'Id': 'string',
            'ProductId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ShortDescription': 'string',
            'Type': 'CLOUD_FORMATION_TEMPLATE',
            'Distributor': 'string',
            'HasDefaultPath': True|False,
            'SupportEmail': 'string',
            'SupportDescription': 'string',
            'SupportUrl': 'string'
        },
    ],
    'ProductViewAggregations': {
        'string': [
            {
                'Value': 'string',
                'ApproximateCount': 123
            },
        ]
    },
    'NextPageToken': 'string'
}

Response Structure

(dict) --
- ProductViewSummaries (list) --
  
  A list of the product view summary objects.
  - (dict) --
    
    The summary metadata about the specified product.
    - Id (string) --
      
      The product view identifier.
    - ProductId (string) --
      
      The product identifier.
    - Name (string) --
      
      The name of the product.
    - Owner (string) --
      
      The owner of the product. Contact the product administrator for the significance of this value.
    - ShortDescription (string) --
      
      Short description of the product.
    - Type (string) --
      
      The product type. Contact the product administrator for the significance of this value.
    - Distributor (string) --
      
      The distributor of the product. Contact the product administrator for the significance of this value.
    - HasDefaultPath (boolean) --
      
      A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.
    - SupportEmail (string) --
      
      The email contact information to obtain support for this Product.
    - SupportDescription (string) --
      
      The description of the support for this Product.
    - SupportUrl (string) --
      
      The URL information to obtain support for this Product.
- ProductViewAggregations (dict) --
  
  A list of the product view aggregation value objects.
  - (string) --
    - (list) --
      - (dict) --
        
        A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.
        
        Value (string) --
        
        The value of the product view aggregation.
        
        ApproximateCount (integer) --
        
        An approximate count of the products that match the value.
- NextPageToken (string) --
  
  The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.