[ aws . connectscheduling ]

get-time-off

Description

Returns a time off request, including its current status and validation results.

See also: AWS API Documentation

Synopsis

  get-time-off
--instance-id <value>
--user-id <value>
--time-off-id <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]
[--cli-error-format <value>]
[--help]

Options

--instance-id (string) [required]

The identifier of the Connect Customer instance. This can be the ID or the ARN of the instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

  • min: 1
  • max: 250
  • pattern: (arn:(aws|aws-us-gov):connect:[a-z]{2}(-[a-z]+){1,2}-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

--user-id (string) [required]

The identifier of the user who the time off request belongs to. This can be the ID or the ARN of the user.

Constraints:

  • min: 1
  • max: 255

--time-off-id (string) [required]

The identifier of the time off request. If the time off request doesn’t belong to UserId , the operation returns ResourceNotFoundException .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9-]+

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

TimeOffId -> (string)

The identifier of the time off request.

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9-]+

UserId -> (string)

The identifier of the user the time off is for.

Constraints:

  • min: 1
  • max: 255

ShiftActivityId -> (string)

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

Constraints:

  • min: 1
  • max: 255

StartAt -> (timestamp)

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

EndAt -> (timestamp)

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

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.

Possible values:

  • PENDING
  • APPROVED
  • REJECTED
  • CANCELLED
  • AWAITING_APPROVAL

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 .

Constraints:

  • min: 1
  • max: 500

ValidationResults -> (list)

Warnings or failures produced while processing the time off request.

(structure)

A warning or failure produced while processing the time off request.

Severity -> (string) [required]

The severity of the validation result. WARNING is a breach of the configured rules that is not enough to reject the request, either because of the rules configuration or because the caller sent RuleFailureAction OVERRIDE . ERROR is a reason the request was rejected.

Possible values:

  • WARNING
  • ERROR

Code -> (string) [required]

The specific reason for the validation result. New values may be added, so treat an unrecognized value as a generic failure of the reported severity.

  • INSUFFICIENT_USER_TIME_OFF_BALANCE : the user’s time off balance for the activity is less than the time this request deducts. Connect Customer deducts only working time in the window. For details, see How the system calculates time off deductions in the Connect Customer Administrator Guide .
  • INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE : the time off allowance of the user’s forecast group or demand group for the activity is too low for this request.
  • INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE : the daily time off allowance of the user’s staffing group for the activity is too low for this request.
  • CONFLICTING_TIME_OFF_REQUEST : the request overlaps another time off request for the user that is APPROVED or being approved. Requests in AWAITING_APPROVAL don’t count. For CreateTimeOff with AUTOMATIC , overlapping overtime and voluntary time off also count.

Possible values:

  • INSUFFICIENT_USER_TIME_OFF_BALANCE
  • INSUFFICIENT_GROUP_TIME_OFF_ALLOWANCE
  • INSUFFICIENT_STAFFING_GROUP_TIME_OFF_ALLOWANCE
  • CONFLICTING_TIME_OFF_REQUEST

CreatedBy -> (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ConnectUserArn, AWSIdentityArn.

ConnectUserArn -> (string)

The ARN of the Connect Customer user who performed the action.

Constraints:

  • min: 0
  • max: 2048

AWSIdentityArn -> (string)

The IAM or AWS STS ARN of the identity that performed the action. Present when that identity is not a Connect Customer user.

Constraints:

  • min: 0
  • max: 2048

CreatedAt -> (timestamp)

The timestamp when the time off request was created.

UpdatedBy -> (tagged union structure)

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 .

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ConnectUserArn, AWSIdentityArn.

ConnectUserArn -> (string)

The ARN of the Connect Customer user who performed the action.

Constraints:

  • min: 0
  • max: 2048

AWSIdentityArn -> (string)

The IAM or AWS STS ARN of the identity that performed the action. Present when that identity is not a Connect Customer user.

Constraints:

  • min: 0
  • max: 2048

UpdatedAt -> (timestamp)

The timestamp when the time off request was last modified.