Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetBandwidthRateLimitSchedule

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

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 180.

Pattern: arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+

Required: Yes

Response Syntax


{
   "BandwidthRateLimitIntervals": [ 
      { 
         "AverageUploadRateLimitInBitsPerSec": number,
         "DaysOfWeek": [ number ],
         "EndHourOfDay": number,
         "EndMinuteOfHour": number,
         "StartHourOfDay": number,
         "StartMinuteOfHour": number
      }
   ],
   "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.

BandwidthRateLimitIntervals

An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

Type: Array of BandwidthRateLimitInterval objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

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 180.

Pattern: arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}\/[a-zA-Z-0-9]+

Errors

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

InternalServerException

The operation did not succeed because an internal error occurred. Try again later.

ErrorCode: A description of which internal error occured.

HTTP Status Code: 500

ResourceNotFoundException

A resource that is required for the action wasn't found.

ErrorCode: A description of which resource wasn't found.

HTTP Status Code: 400

ThrottlingException

TPS has been limited to protect against intentional or unintentional high request volumes.

ErrorCode: Error: TPS has been limited to protect against intentional or unintentional high request volumes.

HTTP Status Code: 400

ValidationException

The operation did not succeed because a validation error occurred.

ErrorCode: A description of what caused the validation error.

HTTP Status Code: 400