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

AWS Documentation » AWS RAM » API Reference » Actions » GetResourceShareInvitations

GetResourceShareInvitations

Gets the invitations for resource sharing that you've received.

Request Syntax

POST /getresourceshareinvitations HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "resourceShareArns": [ "string" ],
   "resourceShareInvitationArns": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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

resourceShareArns

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

Type: Array of strings

Required: No

resourceShareInvitationArns

The Amazon Resource Names (ARN) of the invitations.

Type: Array of strings

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourceShareInvitations": [ 
      { 
         "invitationTimestamp": number,
         "receiverAccountId": "string",
         "resourceShareArn": "string",
         "resourceShareAssociations": [ 
            { 
               "associatedEntity": "string",
               "associationType": "string",
               "creationTime": number,
               "external": boolean,
               "lastUpdatedTime": number,
               "resourceShareArn": "string",
               "status": "string",
               "statusMessage": "string"
            }
         ],
         "resourceShareInvitationArn": "string",
         "resourceShareName": "string",
         "senderAccountId": "string",
         "status": "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

resourceShareInvitations

Information about the invitations.

Type: Array of ResourceShareInvitation objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidMaxResultsException

The specified value for MaxResults is not valid.

HTTP Status Code: 400

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

ResourceShareInvitationArnNotFoundException

The Amazon Resource Name (ARN) for an invitation was not found.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: