Sign In to the Console
AWS Resource Access Manager
API Reference (API Version 2018-01-04)

AWS Documentation » AWS RAM » API Reference » Actions » GetResourceShareAssociations

GetResourceShareAssociations

Gets the resources or principals for the 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.

associationStatus

The association status.

Type: String

Valid Values: ASSOCIATING | ASSOCIATED | FAILED | DISASSOCIATING | DISASSOCIATED

Required: No

associationType

The association type. Specify PRINCIPAL to list the principals that are associated with the specified resource share. Specify RESOURCE to list the resources that are associated with the specified resource share.

Type: String

Valid Values: PRINCIPAL | RESOURCE

Required: Yes

maxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

nextToken

The token for the next page of results.

Type: String

Required: No

principal

The principal. You cannot specify this parameter if the association type is RESOURCE.

Type: String

Required: No

resourceArn

The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL.

Type: String

Required: No

resourceShareArns

The Amazon Resource Names (ARN) of the resource shares.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

resourceShareAssociations

Information 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: