update_portfolio

update_portfolio(**kwargs)

Updates the specified portfolio.

You cannot update a product that was shared with you.

See also: AWS API Documentation

Request Syntax

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

    The language code.

    • en - English (default)
    • jp - Japanese
    • zh - Chinese
  • Id (string) --

    [REQUIRED]

    The portfolio identifier.

  • DisplayName (string) -- The name to use for display purposes.
  • Description (string) -- The updated description of the portfolio.
  • ProviderName (string) -- The updated name of the portfolio provider.
  • AddTags (list) --

    The tags to add.

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

  • RemoveTags (list) --

    The tags to remove.

    • (string) --
Return type

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

      Information about the portfolio.

      • Id (string) --

        The portfolio identifier.

      • ARN (string) --

        The ARN assigned to the portfolio.

      • DisplayName (string) --

        The name to use for display purposes.

      • Description (string) --

        The description of the portfolio.

      • CreatedTime (datetime) --

        The UTC time stamp of the creation time.

      • ProviderName (string) --

        The name of the portfolio provider.

    • Tags (list) --

      Information about the tags associated with the portfolio.

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

Exceptions

  • ServiceCatalog.Client.exceptions.InvalidParametersException
  • ServiceCatalog.Client.exceptions.ResourceNotFoundException
  • ServiceCatalog.Client.exceptions.LimitExceededException
  • ServiceCatalog.Client.exceptions.TagOptionNotMigratedException