ListTapePools - AWS Storage Gateway Service

ListTapePools

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools.

This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

Request Syntax

{ "Limit": number, "Marker": "string", "PoolARNs": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Limit

An optional number limit for the tape pools in the list returned by this call.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Marker

A string that indicates the position at which to begin the returned list of tape pools.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

PoolARNs

The Amazon Resource Name (ARN) of each of the custom tape pools you want to list. If you don't specify a custom tape pool ARN, the response lists all custom tape pools.

Type: Array of strings

Length Constraints: Minimum length of 50. Maximum length of 500.

Required: No

Response Syntax

{ "Marker": "string", "PoolInfos": [ { "PoolARN": "string", "PoolName": "string", "PoolStatus": "string", "RetentionLockTimeInDays": number, "RetentionLockType": "string", "StorageClass": "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.

Marker

A string that indicates the position at which to begin the returned list of tape pools. Use the marker in your next request to continue pagination of tape pools. If there are no more tape pools to list, this element does not appear in the response body.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

PoolInfos

An array of PoolInfo objects, where each object describes a single custom tape pool. If there are no custom tape pools, the PoolInfos is an empty array.

Type: Array of PoolInfo objects

Errors

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

InternalServerError

An internal server error has occurred during the request. For more information, see the error and message fields.

HTTP Status Code: 400

InvalidGatewayRequestException

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

HTTP Status Code: 400

See Also

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