GetResourceShareAssociations
Retrieves the resource and principal associations for resource shares that you own.
Request Syntax
POST /getresourceshareassociations HTTP/1.1
Content-type: application/json
{
"associationStatus": "string
",
"associationType": "string
",
"maxResults": number
,
"nextToken": "string
",
"principal": "string
",
"resourceArn": "string
",
"resourceShareArns": [ "string
" ]
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- associationType
-
Specifies whether you want to retrieve the associations that involve a specified resource or principal.
-
PRINCIPAL
– list the principals that are associated with the specified resource share. -
RESOURCE
– list the resources that are associated with the specified resource share.
Type: String
Valid Values:
PRINCIPAL | RESOURCE
Required: Yes
-
- associationStatus
-
Specifies that you want to retrieve only associations with this status.
Type: String
Valid Values:
ASSOCIATING | ASSOCIATED | FAILED | DISASSOCIATING | DISASSOCIATED
Required: No
- maxResults
-
Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the
NextToken
response element is returned with a value (not null). Include the specified value as theNextToken
request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextToken
after every operation to ensure that you receive all of the results.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- nextToken
-
Specifies that you want to receive the next page of results. Valid only if you received a
NextToken
response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call'sNextToken
response to request the next page of results.Type: String
Required: No
- principal
-
Specifies the ID of the principal whose resource shares you want to retrieve. This can be an AWS account ID, an organization ID, an organizational unit ID, or the Amazon Resoure Name (ARN) of an individual IAM user or role.
You cannot specify this parameter if the association type is
RESOURCE
.Type: String
Required: No
- resourceArn
-
Specifies the Amazon Resoure Name (ARN) of the resource whose resource shares you want to retrieve.
You cannot specify this parameter if the association type is
PRINCIPAL
.Type: String
Required: No
- resourceShareArns
-
Specifies a list of Amazon Resource Names (ARNs) of the resource share whose associations you want to retrieve.
Type: Array of strings
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "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.
- nextToken
-
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 theNextToken
response element comes back asnull
. This indicates that this is the last page of results.Type: String
- resourceShareAssociations
-
An array of objects that contain the details about the associations.
Type: Array of ResourceShareAssociation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The specified value for
NextToken
is not valid.HTTP Status Code: 400
- InvalidParameterException
-
A parameter is not valid.
HTTP Status Code: 400
- MalformedArnException
-
The format of an Amazon Resource Name (ARN) is not valid.
HTTP Status Code: 400
- OperationNotPermittedException
-
The requested operation is not permitted.
HTTP Status Code: 400
- ServerInternalException
-
The service could not respond to the request due to an internal problem.
HTTP Status Code: 500
- ServiceUnavailableException
-
The service is not available.
HTTP Status Code: 503
- UnknownResourceException
-
A specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: