AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-contacts ]

update-rotation

Description

Updates the information specified for an on-call rotation.

See also: AWS API Documentation

Synopsis

  update-rotation
--rotation-id <value>
[--contact-ids <value>]
[--start-time <value>]
[--time-zone-id <value>]
--recurrence <value>
[--cli-input-json <value>]
[--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>]

Options

--rotation-id (string)

The Amazon Resource Name (ARN) of the rotation to update.

--contact-ids (list)

The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.

The order in which you list the contacts is their shift order in the rotation schedule.

(string)

Syntax:

"string" "string" ...

--start-time (timestamp)

The date and time the rotation goes into effect.

--time-zone-id (string)

The time zone to base the updated rotation’s activity on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

Note

Designators for time zones that don’t support Daylight Savings Time Rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), aren't supported.

--recurrence (structure)

Information about how long the updated rotation lasts before restarting at the beginning of the shift order.

MonthlySettings -> (list)

Information about on-call rotations that recur monthly.

(structure)

Information about on-call rotations that recur monthly.

DayOfMonth -> (integer)

The day of the month when monthly recurring on-call rotations begin.

HandOffTime -> (structure)

The time of day when a monthly recurring on-call shift rotation begins.

HourOfDay -> (integer)

The hour when an on-call rotation shift begins or ends.

MinuteOfHour -> (integer)

The minute when an on-call rotation shift begins or ends.

WeeklySettings -> (list)

Information about on-call rotations that recur weekly.

(structure)

Information about rotations that recur weekly.

DayOfWeek -> (string)

The day of the week when weekly recurring on-call shift rotations begins.

HandOffTime -> (structure)

The time of day when a weekly recurring on-call shift rotation begins.

HourOfDay -> (integer)

The hour when an on-call rotation shift begins or ends.

MinuteOfHour -> (integer)

The minute when an on-call rotation shift begins or ends.

DailySettings -> (list)

Information about on-call rotations that recur daily.

(structure)

Details about when an on-call rotation shift begins or ends.

HourOfDay -> (integer)

The hour when an on-call rotation shift begins or ends.

MinuteOfHour -> (integer)

The minute when an on-call rotation shift begins or ends.

NumberOfOnCalls -> (integer)

The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.

ShiftCoverages -> (map)

Information about the days of the week included in on-call rotation coverage.

key -> (string)

value -> (list)

(structure)

Information about when an on-call shift begins and ends.

Start -> (structure)

Information about when the on-call rotation shift begins.

HourOfDay -> (integer)

The hour when an on-call rotation shift begins or ends.

MinuteOfHour -> (integer)

The minute when an on-call rotation shift begins or ends.

End -> (structure)

Information about when the on-call rotation shift ends.

HourOfDay -> (integer)

The hour when an on-call rotation shift begins or ends.

MinuteOfHour -> (integer)

The minute when an on-call rotation shift begins or ends.

RecurrenceMultiplier -> (integer)

The number of days, weeks, or months a single rotation lasts.

JSON Syntax:

{
  "MonthlySettings": [
    {
      "DayOfMonth": integer,
      "HandOffTime": {
        "HourOfDay": integer,
        "MinuteOfHour": integer
      }
    }
    ...
  ],
  "WeeklySettings": [
    {
      "DayOfWeek": "MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|"SUN",
      "HandOffTime": {
        "HourOfDay": integer,
        "MinuteOfHour": integer
      }
    }
    ...
  ],
  "DailySettings": [
    {
      "HourOfDay": integer,
      "MinuteOfHour": integer
    }
    ...
  ],
  "NumberOfOnCalls": integer,
  "ShiftCoverages": {"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|"SUN": [
        {
          "Start": {
            "HourOfDay": integer,
            "MinuteOfHour": integer
          },
          "End": {
            "HourOfDay": integer,
            "MinuteOfHour": integer
          }
        }
        ...
      ]
    ...},
  "RecurrenceMultiplier": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

None