ListAutomaticTapeCreationPolicies
Lists the automatic tape creation policies for a gateway. If there are no automatic tape creation policies for the gateway, it returns an empty list.
This operation is only supported for tape gateways.
Request Syntax
{
"GatewayARN": "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.
- GatewayARN
-
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: No
Response Syntax
{
"AutomaticTapeCreationPolicyInfos": [
{
"AutomaticTapeCreationRules": [
{
"MinimumNumTapes": number,
"PoolId": "string",
"TapeBarcodePrefix": "string",
"TapeSizeInBytes": number,
"Worm": boolean
}
],
"GatewayARN": "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.
- AutomaticTapeCreationPolicyInfos
-
Gets a listing of information about the gateway's automatic tape creation policies, including the automatic tape creation rules and the gateway that is using the policies.
Type: Array of AutomaticTapeCreationPolicyInfo 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
Examples
List automatic tape creation policies for a tape gateway
In the following request, you get a listing of the automatic tape creation
policies for a tape gateway with the ARN of "sgw-tan".
Sample Request
{
"GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
}
Sample Response
{
"AutomaticTapeCreationPolicyInfos": [
{
"AutomaticTapeCreationRules": [
{
"MinimumNumTapes": "1",
"PoolId": "GLACIER",
"TapeBarcodePrefix": "TAN",
"TapeSizeInBytes": "107374182400"
}
],
"GatewayARN": "arn:aws:storagegateway:us-east-1:346332347513:gateway/sgw-tan"
}
]
} See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
