Did you find this page useful? Do you have a suggestion to improve the documentation? Give us feedback.
If you would like to suggest an improvement or fix for the AWS CLI, check out our contributing guide on GitHub.
First time using the AWS CLI? See the User Guide for help getting started.
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
accept-resource-share-invitation
--resource-share-invitation-arn <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--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.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--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.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
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 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"
}
}
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.