[ aws . ram ]

accept-resource-share-invitation

Description

Accepts an invitation to a resource share from another Amazon Web Services account. After you accept the invitation, the resources included in the resource share are available to interact with in the relevant Amazon Web Services Management Consoles and tools.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  accept-resource-share-invitation
--resource-share-invitation-arn <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--resource-share-invitation-arn (string)

The Amazon Resoure Name (ARN) of the invitation that you want to accept.

--client-token (string)

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value. .

If you don’t provide this value, then Amazon Web Services generates a random one for you.

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

--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 accept a resource share invitation

The following accept-resource-share-invitation example accepts the specified resource share invitation. Principals in the invited account can immediately start using the resources in the share.

aws ram accept-resource-share-invitation \
    --resource-share-invitation-arn arn:aws:ram:us-west-2:111111111111:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE

Output:

{
    "resourceShareInvitation": {
        "resourceShareInvitationArn": "arn:aws:ram:us-west-2:111111111111:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE",
        "resourceShareName": "MyLicenseShare",
        "resourceShareArn": "arn:aws:ram:us-west-2:111111111111:resource-share/27d09b4b-5e12-41d1-a4f2-19dedEXAMPLE",
        "senderAccountId": "111111111111",
        "receiverAccountId": "222222222222",
        "invitationTimestamp": "2021-09-22T15:07:35.620000-07:00",
        "status": "ACCEPTED"
    }
}

Output

resourceShareInvitation -> (structure)

An object that contains information about the specified invitation.

resourceShareInvitationArn -> (string)

The Amazon Resoure Name (ARN) of the invitation.

resourceShareName -> (string)

The name of the resource share.

resourceShareArn -> (string)

The Amazon Resoure 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 with a resource share and either a principal or a resource.

resourceShareArn -> (string)

The Amazon Resoure 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 Resoure Name (ARN) of the resource.

• For principal associations, this is one of the following:

  • The ID of an Amazon Web Services account

  • The Amazon Resoure 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 Resoure Name (ARN) of the IAM user or role that received the invitation.

clientToken -> (string)

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.