[ aws . servicecatalog ]

list-accepted-portfolio-shares

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-accepted-portfolio-shares is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PortfolioDetails

Synopsis

  list-accepted-portfolio-shares
[--accept-language <value>]
[--page-size <value>]
[--portfolio-share-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

• en - English (default)

• jp - Japanese

• zh - Chinese

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--portfolio-share-type (string)

The type of shared portfolios to list. The default is to list imported portfolios.

• AWS_ORGANIZATIONS - List portfolios shared by the management account of your organization

• AWS_SERVICECATALOG - List default portfolios

• IMPORTED - List imported portfolios

Possible values:

• IMPORTED

• AWS_SERVICECATALOG

• AWS_ORGANIZATIONS

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See ‘aws help’ for descriptions of global parameters.

Examples

To list accepted portfolio shares

The following list-accepted-portfolio-shares example lists all portfolios for which sharing was accepted by this account, including only the default Service Catalog portfolios.

aws servicecatalog list-accepted-portfolio-shares \
    --portfolio-share-type "AWS_SERVICECATALOG"

Output:

{
    "PortfolioDetails": [
        {
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-d2abcd5dpkuma",
            "Description": "AWS Service Catalog Reference blueprints for often-used AWS services such as EC2, S3, RDS, VPC and EMR.",
            "CreatedTime": 1574456190.687,
            "ProviderName": "AWS Service Catalog",
            "DisplayName": "Reference Architectures",
            "Id": "port-d2abcd5dpkuma"
        },
        {
            "ARN": "arn:aws:catalog:us-west-2:123456789012:portfolio/port-abcdefaua7zpu",
            "Description": "AWS well-architected blueprints for high reliability applications.",
            "CreatedTime": 1574461496.092,
            "ProviderName": "AWS Service Catalog",
            "DisplayName": "High Reliability Architectures",
            "Id": "port-abcdefaua7zpu"
        }
    ]
}

Output

PortfolioDetails -> (list)

Information about the portfolios.

(structure)

Information about a 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.

NextPageToken -> (string)

The page token to use to retrieve the next set of results. If there are no additional results, this value is null.