[ aws . ram ]



Lists the principals that you have shared resources with or that have shared resources with you.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-principals 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: principals


--resource-owner <value>
[--resource-arn <value>]
[--principals <value>]
[--resource-type <value>]
[--resource-share-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--resource-owner (string)

The type of owner.

Possible values:

  • SELF


--resource-arn (string)

The Amazon Resource Name (ARN) of the resource.

--principals (list)

The principals.



"string" "string" ...

--resource-type (string)

The resource type.

Valid values: codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | license-manager:LicenseConfiguration I resource-groups:Group | rds:Cluster | route53resolver:ResolverRule

--resource-share-arns (list)

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



"string" "string" ...

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

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

See ‘aws help’ for descriptions of global parameters.


To list principals with access to a resource

The following list-principals example displays a list of the principals that can access the subnets associated with a resource share.

aws ram list-principals \
    --resource-type ec2:Subnet


    "principals": [
            "id": "arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE",
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "creationTime": 1565298209.737,
            "lastUpdatedTime": 1565298211.019,
            "external": false


principals -> (list)

The principals.


Describes a principal for use with AWS Resource Access Manager.

id -> (string)

The ID of the principal.

resourceShareArn -> (string)

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

creationTime -> (timestamp)

The time when the principal was associated with the resource share.

lastUpdatedTime -> (timestamp)

The time when the association was last updated.

external -> (boolean)

Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

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.