Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetResourceShares

Retrieves details about the resource shares that you own or that are shared with you.

Request Syntax


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

{
   "maxResults": number,
   "name": "string",
   "nextToken": "string",
   "permissionArn": "string",
   "resourceOwner": "string",
   "resourceShareArns": [ "string" ],
   "resourceShareStatus": "string",
   "tagFilters": [ 
      { 
         "tagKey": "string",
         "tagValues": [ "string" ]
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

resourceOwner

Specifies that you want to retrieve details of only those resource shares that match the following:

SELF – resource shares that your account shares with other accounts
OTHER-ACCOUNTS – resource shares that other accounts share with your account

Type: String

Valid Values: SELF | OTHER-ACCOUNTS

Required: Yes

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 the NextToken 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 check NextToken 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

name

Specifies the name of an individual resource share that you want to retrieve details about.

Type: String

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's NextToken response to request the next page of results.

Type: String

Required: No

permissionArn

Specifies that you want to retrieve details of only those resource shares that use the AWS RAM permission with this Amazon Resoure Name (ARN).

Type: String

Required: No

resourceShareArns

Specifies the Amazon Resource Names (ARNs) of individual resource shares that you want information about.

Type: Array of strings

Required: No

resourceShareStatus

Specifies that you want to retrieve details of only those resource shares that have this status.

Type: String

Valid Values: PENDING | ACTIVE | FAILED | DELETING | DELETED

Required: No

tagFilters

Specifies that you want to retrieve details of only those resource shares that match the specified tag keys and values.

Type: Array of TagFilter objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "resourceShares": [ 
      { 
         "allowExternalPrincipals": boolean,
         "creationTime": number,
         "featureSet": "string",
         "lastUpdatedTime": number,
         "name": "string",
         "owningAccountId": "string",
         "resourceShareArn": "string",
         "status": "string",
         "statusMessage": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "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 the NextToken response element comes back as null. This indicates that this is the last page of results.

Type: String

resourceShares

An array of objects that contain the information about the resource shares.

Type: Array of ResourceShare 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

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