get-resource-share-associations¶

Description¶

Gets the resources or principals for the resource shares that you own.

Synopsis¶

  get-resource-share-associations
--association-type <value>
[--resource-share-arns <value>]
[--resource-arn <value>]
[--principal <value>]
[--association-status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--association-type (string)

The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.

Possible values:

PRINCIPAL

RESOURCE

--resource-share-arns (list)

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

(string)

Syntax:

"string" "string" ...

--resource-arn (string)

The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL .

--principal (string)

The principal. You cannot specify this parameter if the association type is RESOURCE .

--association-status (string)

The association status.

Possible values:

ASSOCIATING

ASSOCIATED

FAILED

DISASSOCIATING

DISASSOCIATED

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

Examples¶

Example 1: To list resource associations

The following get-resource-share-associations example lists your resource associations.

aws ram get-resource-share-associations \
    --association-type RESOURCE

Output:

{
    "resourceShareAssociations": [
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235",
            "associationType": "RESOURCE",
            "status": "ASSOCIATED",
            "creationTime": 1565303590.973,
            "lastUpdatedTime": 1565303591.695,
            "external": false
        }
    ]
}

Example 2: To list principal associations

The following get-resource-share-associations example lists the principal associations for the specified resource share.

aws ram get-resource-share-associations \
    --association-type PRINCIPAL \
    --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE

Output:

{
    "resourceShareAssociations": [
        {
            "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE",
            "associatedEntity": "0abcdef1234567890",
            "associationType": "PRINCIPAL",
            "status": "ASSOCIATED",
            "creationTime": 1565296791.818,
            "lastUpdatedTime": 1565296792.119,
            "external": true
        }
    ]
}

Output¶

resourceShareAssociations -> (list)

Information about the associations.

(structure)

Describes an association with a resource share.

resourceShareArn -> (string)

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

resourceShareName -> (string)

The name of the resource share.

associatedEntity -> (string)

The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

associationType -> (string)

The association type.

status -> (string)

The status of the association.

statusMessage -> (string)

A message about the status of the association.

creationTime -> (timestamp)

The time when the association was created.

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.

Table of Contents

Feedback

User Guide