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

ListShares

Retrieves the resource shares associated with an account. Use the filter parameter to retrieve a specific subset of the shares.

Request Syntax


POST /shares?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "filter": { 
      "resourceArns": [ "string" ],
      "status": [ "string" ],
      "type": [ "string" ]
   },
   "resourceOwner": "string"
}

URI Request Parameters

The request uses the following URI parameters.

maxResults: The maximum number of shares to return in one page of results.
nextToken: Next token returned in the response of a previous ListReadSetUploadPartsRequest call. Used to get the next page of results.

Request Body

The request accepts the following data in JSON format.

filter

Attributes that you use to filter for a specific subset of resource shares.

Type: Filter object

Required: No

resourceOwner

The account that owns the resource shares.

Type: String

Valid Values: SELF | OTHER

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "shares": [ 
      { 
         "creationTime": "string",
         "ownerId": "string",
         "principalSubscriber": "string",
         "resourceArn": "string",
         "resourceId": "string",
         "shareId": "string",
         "shareName": "string",
         "status": "string",
         "statusMessage": "string",
         "updateTime": "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

Next token returned in the response of a previous ListSharesResponse call. Used to get the next page of results.

Type: String

shares

The shares available and their metadata details.

Type: Array of ShareDetails objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request cannot be applied to the target resource in its current state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred. Try the request again.

HTTP Status Code: 500

ResourceNotFoundException

The target resource was not found in the current Region.

HTTP Status Code: 404

ServiceQuotaExceededException

The request exceeds a service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400