Class: Aws::SSMContacts::Types::ListPreviewRotationShiftsRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSMContacts::Types::ListPreviewRotationShiftsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssmcontacts/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The date and time a rotation shift would end.

• #max_results ⇒ Integer

  The maximum number of items to return for this call.

• #members ⇒ Array<String>

  The contacts that would be assigned to a rotation.

• #next_token ⇒ String

  A token to start the list.

• #overrides ⇒ Array<Types::PreviewOverride>

  Information about changes that would be made in a rotation override.

• #recurrence ⇒ Types::RecurrenceSettings

  Information about how long a rotation would last before restarting at the beginning of the shift order.

• #rotation_start_time ⇒ Time

  The date and time a rotation would begin.

• #start_time ⇒ Time

  Used to filter the range of calculated shifts before sending the response back to the user.

• #time_zone_id ⇒ String

  The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format.

Instance Attribute Details

#end_time ⇒ Time

The date and time a rotation shift would end.

Returns:

• (Time)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set of results.

Returns:

• (Integer)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#members ⇒ Array<String>

The contacts that would be assigned to a rotation.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token to start the list. This token is used to get the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#overrides ⇒ Array<Types::PreviewOverride>

Information about changes that would be made in a rotation override.

Returns:

• (Array<Types::PreviewOverride>)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#recurrence ⇒ Types::RecurrenceSettings

Information about how long a rotation would last before restarting at the beginning of the shift order.

Returns:

• (Types::RecurrenceSettings)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#rotation_start_time ⇒ Time

The date and time a rotation would begin. The first shift is calculated from this date and time.

Returns:

• (Time)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

Used to filter the range of calculated shifts before sending the response back to the user.

Returns:

• (Time)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#time_zone_id ⇒ String

The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: “America/Los_Angeles”, “UTC”, or “Asia/Seoul”.

Returns:

• (String)

# File 'lib/aws-sdk-ssmcontacts/types.rb', line 1489

class ListPreviewRotationShiftsRequest < Struct.new(
  :rotation_start_time,
  :start_time,
  :end_time,
  :members,
  :time_zone_id,
  :recurrence,
  :overrides,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end