AWS CLI Command Reference

[ aws . ram ]

get-resource-shares

Description

Gets the resource shares that you own or the resource shares that are shared with you.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-resource-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: resourceShares

Synopsis

  get-resource-shares
[--resource-share-arns <value>]
[--resource-share-status <value>]
--resource-owner <value>
[--name <value>]
[--tag-filters <value>]
[--permission-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--resource-share-arns (list)

The Amazon Resource Names (ARNs) of the resource shares.

(string)

Syntax:

"string" "string" ...

--resource-share-status (string)

The status of the resource share.

Possible values:

  • PENDING

  • ACTIVE

  • FAILED

  • DELETING

  • DELETED

--resource-owner (string)

The type of owner.

Possible values:

  • SELF

  • OTHER-ACCOUNTS

--name (string)

The name of the resource share.

--tag-filters (list)

One or more tag filters.

(structure)

Used to filter information based on tags.

tagKey -> (string)

The tag key.

tagValues -> (list)

The tag values.

(string)

Shorthand Syntax:

tagKey=string,tagValues=string,string ...

JSON Syntax:

[
  {
    "tagKey": "string",
    "tagValues": ["string", ...]
  }
  ...
]

--permission-arn (string)

The Amazon Resource Name (ARN) of the RAM permission that is associated with the resource share.

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

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

--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 your resource shares

The following get-resource-shares example lists your resource shares.

aws ram get-resource-shares \
    --resource-owner SELF

Output:

{
    "resourceShares": [
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE",
            "name": "my-resource-share",
            "owningAccountId": "123456789012",
            "allowExternalPrincipals": false,
            "status": "ACTIVE",
            "tags": [
                {
                    "key": "project",
                    "value": "lima"
                }
            ]
            "creationTime": 1565295733.282,
            "lastUpdatedTime": 1565295733.282
        },
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "name": "my-resource-share",
            "owningAccountId": "123456789012",
            "allowExternalPrincipals": true,
            "status": "ACTIVE",
            "creationTime": 1565295733.282,
            "lastUpdatedTime": 1565295733.282
        }
    ]
}

Output

resourceShares -> (list)

Information about the resource shares.

(structure)

Describes a resource share.

resourceShareArn -> (string)

The Amazon Resource Name (ARN) of the resource share.

name -> (string)

The name of the resource share.

owningAccountId -> (string)

The ID of the Amazon Web Services account that owns the resource share.

allowExternalPrincipals -> (boolean)

Indicates whether principals outside your organization in Organizations can be associated with a resource share.

status -> (string)

The status of the resource share.

statusMessage -> (string)

A message about the status of the resource share.

tags -> (list)

The tags for the resource share.

(structure)

Information about a tag.

key -> (string)

The key of the tag.

value -> (string)

The value of the tag.

creationTime -> (timestamp)

The time when the resource share was created.

lastUpdatedTime -> (timestamp)

The time when the resource share was last updated.

featureSet -> (string)

Indicates how the resource share was created. Possible values include:

  • CREATED_FROM_POLICY - Indicates that the resource share was created from an Amazon Web Services Identity and Access Management (Amazon Web Services IAM) policy attached to a resource. These resource shares are visible only to the Amazon Web Services account that created it. They cannot be modified in RAM.

  • PROMOTING_TO_STANDARD - The resource share is in the process of being promoted. For more information, see PromoteResourceShareCreatedFromPolicy .

  • STANDARD - Indicates that the resource share was created in RAM using the console or APIs. These resource shares are visible to all principals. They can be modified in RAM.

nextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

© Copyright 2018, Amazon Web Services. Created using Sphinx.