Class: Aws::ConnectScheduling::Types::GetTimeOffResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb

Overview

The response for GetTimeOff.

Constant Summary collapse

SENSITIVE =
[:description]

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The timestamp when the time off request was created.

Returns:

  • (Time)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#created_by ⇒ Types::ActorInfo

The identity that created the request. Immutable for the life of the request.

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The description of the time off request. CreateTimeOff sets it, and CancelTimeOff replaces or removes it. An edit in the Connect Customer admin website can also change it. GetTimeOff doesn't return descriptions sent with ApproveTimeOff or RejectTimeOff.

Returns:

  • (String)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#end_at ⇒ Time

The end of the time off window, exclusive, as sent to CreateTimeOff.

Returns:

  • (Time)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#shift_activity_id ⇒ String

The identifier of the shift activity for the time off request.

Returns:

  • (String)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#start_at ⇒ Time

The start of the time off window, inclusive, as sent to CreateTimeOff.

Returns:

  • (Time)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#status ⇒ String

The status of the time off request.

  • PENDING: Connect Customer is processing a change to the request, which then changes to another status. An edit in the Connect Customer admin website can also make a request PENDING, so an APPROVED request can become PENDING and then end APPROVED or REJECTED.

  • AWAITING_APPROVAL: the request is waiting for an ApproveTimeOff or RejectTimeOff call.

Returns:

  • (String)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#time_off_id ⇒ String

The identifier of the time off request.

Returns:

  • (String)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the time off request was last modified.

Returns:

  • (Time)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#updated_by ⇒ Types::ActorInfo

The identity that made the most recent ApproveTimeOff, RejectTimeOff, or CancelTimeOff call on the request, or took the same action in the Connect Customer admin website. Absent until one of those actions is taken, including after Connect Customer decides an AUTOMATIC request. UpdatedAt also changes when a PENDING request changes to another status and for other edits, which don't set UpdatedBy.

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#user_id ⇒ String

The identifier of the user the time off is for.

Returns:

  • (String)


414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end

#validation_results ⇒ Array<Types::TimeOffValidationResult>

Warnings or failures produced while processing the time off request.

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'gems/aws-sdk-connectscheduling/lib/aws-sdk-connectscheduling/types.rb', line 414

class GetTimeOffResponse < Struct.new(
  :time_off_id,
  :user_id,
  :shift_activity_id,
  :start_at,
  :end_at,
  :status,
  :description,
  :validation_results,
  :created_by,
  :created_at,
  :updated_by,
  :updated_at)
  SENSITIVE = [:description]
  include Aws::Structure
end