AssociateResourceShare
Adds the specified list of principals and list of resources to a resource share. Principals that already have access to this resource share immediately receive access to the added resources. Newly added principals immediately receive access to the resources shared in this resource share.
Request Syntax
POST /associateresourceshare HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"principals": [ "string
" ],
"resourceArns": [ "string
" ],
"resourceShareArn": "string
",
"sources": [ "string
" ]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
-
Specifies the Amazon Resource Name (ARN) of the resource share that you want to add principals or resources to.
Type: String
Required: Yes
-
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 generates a random one for you.
If you retry the operation with the same
ClientToken
, but with different parameters, the retry fails with anIdempotentParameterMismatch
error.Type: String
Required: No
-
Specifies a list of principals to whom you want to the resource share. This can be
null
if you want to add only resources.What the principals can do with the resources in the share is determined by the Amazon RAM permissions that you associate with the resource share. See AssociateResourceSharePermission.
You can include the following values:
-
An Amazon Web Services account ID, for example:
123456789012
-
An Amazon Resource Name (ARN) of an organization in Amazon Organizations, for example:
arn:aws:organizations::123456789012:organization/o-exampleorgid
-
An ARN of an organizational unit (OU) in Amazon Organizations, for example:
arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
-
An ARN of an IAM role, for example:
arn:aws:iam::123456789012:role/rolename
-
An ARN of an IAM user, for example:
arn:aws:iam::123456789012user/username
-
A service principal name, for example:
service-id.amazonaws.com
Note
Not all resource types can be shared with IAM roles and users. For more information, see Sharing with IAM roles and users in the Amazon Resource Access Manager User Guide.
Type: Array of strings
Required: No
-
-
Specifies a list of Amazon Resource Names (ARNs) of the resources that you want to share. This can be
null
if you want to add only principals.Type: Array of strings
Required: No
-
Specifies from which source accounts the service principal has access to the resources in this resource share.
Type: Array of strings
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"clientToken": "string",
"resourceShareAssociations": [
{
"associatedEntity": "string",
"associationType": "string",
"creationTime": number,
"external": boolean,
"lastUpdatedTime": number,
"resourceShareArn": "string",
"resourceShareName": "string",
"status": "string",
"statusMessage": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
-
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.Type: String
-
An array of objects that contain information about the associations.
Type: Array of ResourceShareAssociation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- IdempotentParameterMismatchException
-
The operation failed because the client token input parameter matched one that was used with a previous call to the operation, but at least one of the other input parameters is different from the previous call.
HTTP Status Code: 400
- InvalidClientTokenException
-
The operation failed because the specified client token isn't valid.
HTTP Status Code: 400
- InvalidParameterException
-
The operation failed because a parameter you specified isn't valid.
HTTP Status Code: 400
- InvalidStateTransitionException
-
The operation failed because the requested operation isn't valid for the resource share in its current state.
HTTP Status Code: 400
- InvalidStateTransitionException
-
The operation failed because the requested operation isn't valid for the resource share in its current state.
HTTP Status Code: 400
- MalformedArnException
-
The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.
HTTP Status Code: 400
- OperationNotPermittedException
-
The operation failed because the requested operation isn't permitted.
HTTP Status Code: 400
- ResourceShareLimitExceededException
-
The operation failed because it would exceed the limit for resource shares for your account. To view the limits for your Amazon Web Services account, see the Amazon RAM page in the Service Quotas console
. HTTP Status Code: 400
- ServerInternalException
-
The operation failed because the service could not respond to the request due to an internal problem. Try again later.
HTTP Status Code: 500
- ServiceUnavailableException
-
The operation failed because the service isn't available. Try again later.
HTTP Status Code: 503
- ThrottlingException
-
The operation failed because it exceeded the rate at which you are allowed to perform this operation. Please try again later.
HTTP Status Code: 429
- UnknownResourceException
-
The operation failed because a specified resource couldn't be found.
HTTP Status Code: 400
- UnknownResourceException
-
The operation failed because a specified resource couldn't be found.
HTTP Status Code: 400
Examples
Note
The examples show the JSON payloads of the request and response pretty printed with white spaces and line breaks for ease for ease of reading.
Example 1: add a principal to a resource share
The following example illustrates adding an organizational unit (OU) as a
principal to a resource share that exists in the Amazon Web Services Region
us-east-1
. After running this command, all
Amazon Web Services accounts in the specified OU can access the resources in the resource share.
Sample Request
POST /associateresourceshare HTTP/1.1
Accept-Encoding: identity
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>>
X-Amz-Date: 20210923T200946Z
{
"principals": [
"arn:aws:organizations::999999999999:ou/o-12345abcde/ou-12ab-1234abcd"
],
"resourceShareArn": "arn:aws:ram:us-east-1:999999999999:resource-share/27d09b4b-5e12-41d1-a4f2-19ded10982e2"
}
Sample Response
HTTP/1.1 200 OK
Date: Thu, 23 Sep 2021 20:09:46 GMT
Content-Type: application/json
Content-Length: <PayloadSizeBytes>
{
"resourceShareAssociations": [
{
"associatedEntity": "arn:aws:organizations::999999999999:ou/o-12345abcde/ou-12ab-1234abcd",
"associationType": "PRINCIPAL",
"external": false,
"resourceShareArn": "arn:aws:ram:us-east-1:999999999999:resource-share/27d09b4b-5e12-41d1-a4f2-19ded10982e2",
"status": "ASSOCIATING"
}
]
}
Example 2: Add a new resource to a resource share
The following example illustrates adding an additional Amazon License Manager configuration to a resource share. After running this command, all Amazon Web Services accounts that can access the resource share can use the new resource.
Sample Request
POST /associateresourceshare HTTP/1.1
Accept-Encoding: identity
User-Agent: <UserAgentString>
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>>
X-Amz-Date: 20210924T190541Z
{
"resourceShareArn": "arn:aws:ram:us-east-1:999999999999:resource-share/27d09b4b-5e12-41d1-a4f2-19ded10982e2",
"resourceArns": [
"arn:aws:license-manager:us-east-1:999999999999:license-configuration:lic-36be0485f5ae379cc74cf8e9242ab143"
]
}
Sample Response
HTTP/1.1 200 OK
Date: Fri, 24 Sep 2021 19:05:42 GMT
Content-Type: application/json
Content-Length: <PayloadSizeBytes>
{
"resourceShareAssociations": [
{
"associatedEntity": "arn:aws:license-manager:us-east-1:999999999999:license-configuration:lic-36be0485f5ae379cc74cf8e9242ab143",
"associationType": "RESOURCE",
"external": false,
"resourceShareArn": "arn:aws:ram:us-east-1:999999999999:resource-share/27d09b4b-5e12-41d1-a4f2-19ded10982e2",
"status": "ASSOCIATING"
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: