AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . servicecatalog ]
Gets information about the specified portfolio.
A delegated admin is authorized to invoke this command.
See also: AWS API Documentation
describe-portfolio
[--accept-language <value>]
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--accept-language
(string)
The language code.
jp
- Japanesezh
- Chinese
--id
(string)
The portfolio identifier.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
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": []
}
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.Owner -> (string)
The Amazon Web Services account Id of the owner account that created the TagOption.
Budgets -> (list)
Information about the associated budgets.
(structure)
Information about a budget.
BudgetName -> (string)
Name of the associated budget.