Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ram ]

get-resource-share-invitations¶

Description¶

Retrieves details about invitations that you have received for resource shares.

Synopsis¶

  get-resource-share-invitations
[--resource-share-invitation-arns <value>]
[--resource-share-arns <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

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

Specifies the Amazon Resource Names (ARNs) of the resource share invitations you want information about.

(string)

Syntax:

"string" "string" ...

--resource-share-arns (list)

Specifies that you want details about invitations only for the resource shares described by this list of Amazon Resource Names (ARNs)

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To list your resource share invitations

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

aws ram get-resource-share-invitations

Output:

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

Output¶

resourceShareInvitations -> (list)

An array of objects that contain the details about the invitations.

(structure)

Describes an invitation for an Amazon Web Services account 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 current status of the invitation.

resourceShareAssociations -> (list)

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

(structure)

Describes an association between a resource share and either a principal or a resource.

resourceShareArn -> (string)

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

resourceShareName -> (string)

The name of the resource share.

associatedEntity -> (string)

The associated entity. This can be either of the following:

For a resource association, this is the Amazon Resource Name (ARN) of the resource.

For principal associations, this is one of the following:

The ID of an Amazon Web Services account

The Amazon Resource Name (ARN) of an organization in Organizations

The ARN of an organizational unit (OU) in Organizations

The ARN of an IAM role

The ARN of an IAM user

associationType -> (string)

The type of entity included in this association.

status -> (string)

The current status of the association.

statusMessage -> (string)

A message about the status of the association.

creationTime -> (timestamp)

The date and time when the association was created.

lastUpdatedTime -> (timestamp)

The date and 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 role that received the invitation.

nextToken -> (string)

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null . This indicates that this is the last page of results.

Table Of Contents

Feedback

User Guide

Note: