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 . mwaa-serverless ]

get-workflow

Description

Retrieves detailed information about a workflow, including its configuration, status, and metadata.

See also: AWS API Documentation

Synopsis

  get-workflow
--workflow-arn <value>
[--workflow-version <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

--workflow-arn (string)

The Amazon Resource Name (ARN) of the workflow you want to retrieve.

--workflow-version (string)

Optional. The specific version of the workflow to retrieve. If not specified, the latest version is returned.

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

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

WorkflowArn -> (string)

The Amazon Resource Name (ARN) of the workflow.

WorkflowVersion -> (string)

The version identifier of the workflow.

Name -> (string)

The name of the workflow.

Description -> (string)

The description of the workflow.

CreatedAt -> (timestamp)

The timestamp when the workflow was created, in ISO 8601 date-time format.

ModifiedAt -> (timestamp)

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

EncryptionConfiguration -> (structure)

The encryption configuration for the workflow.

Type -> (string)

The type of encryption to use. Values are AWS_MANAGED_KEY (Amazon Web Services manages the encryption key) or CUSTOMER_MANAGED_KEY (you provide a KMS key).

KmsKeyId -> (string)

The ID or ARN of the Amazon Web Services KMS key to use for encryption. Required when Type is CUSTOMER_MANAGED_KEY .

LoggingConfiguration -> (structure)

The logging configuration for the workflow.

LogGroupName -> (string)

The name of the CloudWatch log group where workflow execution logs are stored.

EngineVersion -> (integer)

The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that this workflow uses.

WorkflowStatus -> (string)

The current status of the workflow.

DefinitionS3Location -> (structure)

The Amazon S3 location of the workflow definition file.

Bucket -> (string)

The name of the Amazon S3 bucket that contains the workflow definition file.

ObjectKey -> (string)

The key (name) of the workflow definition file within the S3 bucket.

VersionId -> (string)

Optional. The version ID of the workflow definition file in Amazon S3. If not specified, the latest version is used.

ScheduleConfiguration -> (structure)

The schedule configuration for the workflow, including cron expressions for automated execution. Amazon Managed Workflows for Apache Airflow Serverless uses EventBridge Scheduler for cost-effective, timezone-aware scheduling. When a workflow includes schedule information in its YAML definition, the service automatically configures the appropriate triggers for automated execution. Only one version of a workflow can have an active schedule at any given time.

CronExpression -> (string)

A cron expression that defines when the workflow is automatically executed. Uses standard cron syntax.

RoleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role used for workflow execution.

NetworkConfiguration -> (structure)

The network configuration for the workflow execution environment.

SecurityGroupIds -> (list)

A list of VPC security group IDs to associate with the workflow execution environment.

(string)

SubnetIds -> (list)

A list of VPC subnet IDs where the workflow execution environment is deployed.

(string)

TriggerMode -> (string)

The trigger mode for the workflow execution.

WorkflowDefinition -> (string)

The workflow definition content.