AWS CLI Command Reference

[ aws . backup-gateway ]

put-bandwidth-rate-limit-schedule

Description

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway’s bandwidth rate limit schedule.

See also: AWS API Documentation

Synopsis

  put-bandwidth-rate-limit-schedule
--bandwidth-rate-limit-intervals <value>
--gateway-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--bandwidth-rate-limit-intervals (list)

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

(structure)

Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit interval defines a period of time on one or more days of the week, during which bandwidth rate limits are specified for uploading, downloading, or both.

AverageUploadRateLimitInBitsPerSec -> (long)

The average upload rate limit component of the bandwidth rate limit interval, in bits per second. This field does not appear in the response if the upload rate limit is not set.

Note

For Backup Gateway, the minimum value is (Value) .

DaysOfWeek -> (list)

The days of the week component of the bandwidth rate limit interval, represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 represents Saturday.

(integer)

EndHourOfDay -> (integer)

The hour of the day to end the bandwidth rate limit interval.

EndMinuteOfHour -> (integer)

The minute of the hour to end the bandwidth rate limit interval.

Warning

The bandwidth rate limit interval ends at the end of the minute. To end an interval at the end of an hour, use the value 59 .

StartHourOfDay -> (integer)

The hour of the day to start the bandwidth rate limit interval.

StartMinuteOfHour -> (integer)

The minute of the hour to start the bandwidth rate limit interval. The interval begins at the start of that minute. To begin an interval exactly at the start of the hour, use the value 0 .

Shorthand Syntax:

AverageUploadRateLimitInBitsPerSec=long,DaysOfWeek=integer,integer,EndHourOfDay=integer,EndMinuteOfHour=integer,StartHourOfDay=integer,StartMinuteOfHour=integer ...

JSON Syntax:

[
  {
    "AverageUploadRateLimitInBitsPerSec": long,
    "DaysOfWeek": [integer, ...],
    "EndHourOfDay": integer,
    "EndMinuteOfHour": integer,
    "StartHourOfDay": integer,
    "StartMinuteOfHour": integer
  }
  ...
]

--gateway-arn (string)

The Amazon Resource Name (ARN) of the gateway. Use the ` ListGateways https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html`__ operation to return a list of gateways for your account and Amazon Web Services Region.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

  • yaml

  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64

  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

GatewayArn -> (string)

The Amazon Resource Name (ARN) of the gateway. Use the ` ListGateways https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html`__ operation to return a list of gateways for your account and Amazon Web Services Region.

© Copyright 2018, Amazon Web Services. Created using Sphinx.