[ aws . ram ]

get-resource-share-invitations

Description

Gets the invitations that you have received for resource shares.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

get-resource-share-invitations 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: resourceShareInvitations

Synopsis

  get-resource-share-invitations
[--resource-share-invitation-arns <value>]
[--resource-share-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--resource-share-invitation-arns (list)

The Amazon Resource Names (ARN) of the invitations.

(string)

Syntax:

"string" "string" ...

--resource-share-arns (list)

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

(string)

Syntax:

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

See ‘aws help’ for descriptions of global parameters.

Examples

To list your resource share invitations

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

aws ram get-resource-share-invitations

Output:

{
    "resourceShareInvitations": [
        {
            "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE",
            "resourceShareName": "project-resource-share",
            "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1",
            "senderAccountId": "21077EXAMPLE",
            "receiverAccountId": "123456789012",
            "invitationTimestamp": 1565312166.258,
            "status": "PENDING"
        }
    ]
}

Output

resourceShareInvitations -> (list)

Information about the invitations.

(structure)

Describes an invitation to join a resource share.

resourceShareInvitationArn -> (string)

The Amazon Resource Name (ARN) of the invitation.

resourceShareName -> (string)

The name of the resource share.

resourceShareArn -> (string)

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

senderAccountId -> (string)

The ID of the Amazon Web Services account that sent the invitation.

receiverAccountId -> (string)

The ID of the Amazon Web Services account that received the invitation.

invitationTimestamp -> (timestamp)

The date and time when the invitation was sent.

status -> (string)

The status of the invitation.

resourceShareAssociations -> (list)

To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources .

(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 Amazon Resource Name (ARN) of the resource. For principal associations, this is one of the following:

• An Amazon Web Services account ID

• An ARN of an organization in Organizations

• An ARN of an organizational unit (OU) in Organizations

• An ARN of an IAM role

• An ARN of an IAM user

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 organization in Organizations as the Amazon Web Services account that owns the resource share.

receiverArn -> (string)

The Amazon Resource Name (ARN) of the IAM user or IAM role that received the invitation.

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.