[ aws . servicecatalog ]

describe-portfolio

Description

Gets information about the specified portfolio.

A delegated admin is authorized to invoke this command.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-portfolio
[--accept-language <value>]
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--id (string)

The portfolio identifier.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe a portfolio

The following describe-portfolio example displays details for the specified portfolio.

aws servicecatalog describe-portfolio \
    --id port-2s6abcdq5wdh4

Output:

{
    "TagOptions": [],
    "PortfolioDetail": {
        "ARN": "arn:aws:catalog:us-west-2:687558541234:portfolio/port-2s6abcdq5wdh4",
        "Id": "port-2s6wuzyq5wdh4",
        "CreatedTime": 1571337221.555,
        "DisplayName": "my-portfolio",
        "ProviderName": "my-provider"
    },
    "Tags": []
}

Output

PortfolioDetail -> (structure)

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

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.

(structure)

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

(structure)

Information about a TagOption.

Key -> (string)

The TagOption key.

Value -> (string)

The TagOption value.

Active -> (boolean)

The TagOption active state.

Id -> (string)

The TagOption identifier.

Budgets -> (list)

Information about the associated budgets.

(structure)

Information about a budget.

BudgetName -> (string)

Name of the associated budget.