[ aws . mwaa-serverless ]

get-task-instance

Description

Retrieves detailed information about a specific task instance within a workflow run. Task instances represent individual tasks that are executed as part of a workflow in the Amazon Managed Workflows for Apache Airflow Serverless environment. Each task instance runs in an isolated ECS container with dedicated resources and security boundaries. The service tracks task execution state, retry attempts, and provides detailed timing and error information for troubleshooting and monitoring purposes.

See also: AWS API Documentation

Synopsis

  get-task-instance
--workflow-arn <value>
--task-instance-id <value>
--run-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]

Options

--workflow-arn (string) [required]

The Amazon Resource Name (ARN) of the workflow that contains the task instance.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(?:-(?:cn|us-gov|iso|iso-b|iso-e|iso-f))?:airflow-serverless:([a-z]{2}-[a-z]+-[0-9]{1}):([0-9]{12}):workflow/([a-zA-Z0-9][a-zA-Z0-9\.\-_]{0,254}-[a-zA-Z0-9]{10})

--task-instance-id (string) [required]

The unique identifier of the task instance to retrieve.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*

--run-id (string) [required]

The unique identifier of the workflow run that contains the task instance.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-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

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

WorkflowArn -> (string)

The Amazon Resource Name (ARN) of the workflow that contains this task instance.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(?:-(?:cn|us-gov|iso|iso-b|iso-e|iso-f))?:airflow-serverless:([a-z]{2}-[a-z]+-[0-9]{1}):([0-9]{12}):workflow/([a-zA-Z0-9][a-zA-Z0-9\.\-_]{0,254}-[a-zA-Z0-9]{10})

RunId -> (string)

The unique identifier of the workflow run that contains this task instance.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*

TaskInstanceId -> (string)

The unique identifier of this task instance.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*

WorkflowVersion -> (string)

The version of the workflow that contains this task instance.

Constraints:

• min: 1
• max: 2048
• pattern: .+

Status -> (string)

The current status of the task instance.

Possible values:

• QUEUED
• FAILED
• SCHEDULED
• RUNNING
• SUCCESS
• UP_FOR_RESCHEDULE
• UP_FOR_RETRY
• UPSTREAM_FAILED
• REMOVED
• RESTARTING
• DEFERRED
• NONE
• CANCELLED
• TIMEOUT

DurationInSeconds -> (integer)

The duration of the task instance execution in seconds. This value is null if the task is not complete.

OperatorName -> (string)

The name of the Apache Airflow operator used for this task instance.

Constraints:

• min: 1
• max: 255
• pattern: .*

ModifiedAt -> (timestamp)

The timestamp when the task instance was last modified, in ISO 8601 date-time format.

EndedAt -> (timestamp)

The timestamp when the task instance completed execution, in ISO 8601 date-time format. This value is null if the task is not complete.

StartedAt -> (timestamp)

The timestamp when the task instance started execution, in ISO 8601 date-time format. This value is null if the task has not started.

AttemptNumber -> (integer)

The attempt number for this task instance.

ErrorMessage -> (string)

The error message if the task instance failed. This value is null if the task completed successfully.

Constraints:

• min: 1
• max: 255
• pattern: .*

TaskId -> (string)

The unique identifier of the task definition within the workflow.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*

LogStream -> (string)

The CloudWatch log stream name for this task instance execution.

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*

Xcom -> (map)

Cross-communication data exchanged between tasks in the workflow execution.

key -> (string)

Constraints:

• min: 1
• max: 255
• pattern: .*

value -> (string)

Constraints:

• min: 1
• max: 255
• pattern: .*