Class: Aws::MWAAServerless::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-mwaaserverless/client.rb

Overview

An API client for MWAAServerless. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::MWAAServerless::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting `ENV` to `true`.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and `adaptive` retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - A retry mode that includes all the functionality of `standard` mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::MWAAServerless::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::MWAAServerless::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 478

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1416
1417
1418
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1416

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1419
1420
1421
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1419

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1389

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::MWAAServerless')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-mwaaserverless'
  context[:gem_version] = '1.7.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_workflow(params = {}) ⇒ Types::CreateWorkflowResponse

Creates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless. This operation initializes a workflow with the specified configuration including the workflow definition, execution role, and optional settings for encryption, logging, and networking. You must provide the workflow definition as a YAML file stored in Amazon S3 that defines the DAG structure using supported Amazon Web Services operators. Amazon Managed Workflows for Apache Airflow Serverless automatically creates the first version of the workflow and sets up the necessary execution environment with multi-tenant isolation and security controls.

Examples:

Request syntax with placeholder values


resp = client.create_workflow({
  name: "NameString", # required
  client_token: "IdempotencyTokenString",
  definition_s3_location: { # required
    bucket: "String", # required
    object_key: "String", # required
    version_id: "String",
  },
  role_arn: "RoleARN", # required
  description: "DescriptionString",
  encryption_configuration: {
    type: "AWS_MANAGED_KEY", # required, accepts AWS_MANAGED_KEY, CUSTOMER_MANAGED_KEY
    kms_key_id: "String",
  },
  logging_configuration: {
    log_group_name: "String", # required
  },
  engine_version: 1,
  network_configuration: {
    security_group_ids: ["SecurityGroupString"],
    subnet_ids: ["SubnetString"],
  },
  tags: {
    "TagKey" => "TagValue",
  },
  trigger_mode: "GenericString",
})

Response structure


resp.workflow_arn #=> String
resp.created_at #=> Time
resp.revision_id #=> String
resp.workflow_status #=> String, one of "READY", "DELETING"
resp.workflow_version #=> String
resp.is_latest_version #=> Boolean
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the workflow. You must use unique workflow names within your Amazon Web Services account. The service generates a unique identifier that is appended to ensure temporal uniqueness across the account lifecycle.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow creation requests.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :definition_s3_location (required, Types::DefinitionS3Location) —

    The Amazon S3 location where the workflow definition file is stored. This must point to a valid YAML file that defines the workflow structure using supported Amazon Web Services operators and tasks. Amazon Managed Workflows for Apache Airflow Serverless takes a snapshot of the definition at creation time, so subsequent changes to the Amazon S3 object will not affect the workflow unless you create a new version. In your YAML definition, include task dependencies, scheduling information, and operator configurations that are compatible with the Amazon Managed Workflows for Apache Airflow Serverless execution environment.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when executing the workflow. This role must have the necessary permissions to access the required Amazon Web Services services and resources that your workflow tasks will interact with. The role is used for task execution in the isolated, multi-tenant environment and should follow the principle of least privilege. Amazon Managed Workflows for Apache Airflow Serverless validates role access during workflow creation but runtime permission checks are performed by the target services.

  • :description (String) —

    An optional description of the workflow that you can use to provide additional context about the workflow’s purpose and functionality.

  • :encryption_configuration (Types::EncryptionConfiguration) —

    The configuration for encrypting workflow data at rest and in transit. Specifies the encryption type and optional KMS key for customer-managed encryption.

  • :logging_configuration (Types::LoggingConfiguration) —

    The configuration for workflow logging. Specifies the CloudWatch log group where workflow execution logs are stored. Amazon Managed Workflows for Apache Airflow Serverless automatically exports worker logs and task-level information to the specified log group in your account using remote logging functionality. This provides comprehensive observability for debugging and monitoring workflow execution across the distributed, serverless environment.

  • :engine_version (Integer) —

    The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for this workflow. This determines the feature set, supported operators, and execution environment capabilities available to your workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains backward compatibility across versions while introducing new features and improvements. Currently supports version 1 with plans for additional versions as the service evolves.

  • :network_configuration (Types::NetworkConfiguration) —

    Network configuration for the workflow execution environment, including VPC security groups and subnets for secure network access. When specified, Amazon Managed Workflows for Apache Airflow Serverless deploys ECS worker tasks in your customer VPC to provide secure connectivity to your resources. If not specified, tasks run in the service’s default worker VPC with network isolation from other customers. This configuration enables secure access to VPC-only resources like RDS databases or private endpoints.

  • :tags (Hash<String,String>) —

    A map of tags to assign to the workflow resource. Tags are key-value pairs that are used for resource organization and cost allocation.

  • :trigger_mode (String) —

    The trigger mode for the workflow execution.

Returns:

See Also:



632
633
634
635
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 632

def create_workflow(params = {}, options = {})
  req = build_request(:create_workflow, params)
  req.send_request(options)
end

#delete_workflow(params = {}) ⇒ Types::DeleteWorkflowResponse

Deletes a workflow and all its versions. This operation permanently removes the workflow and cannot be undone. Amazon Managed Workflows for Apache Airflow Serverless ensures that all associated resources are properly cleaned up, including stopping any running executions, removing scheduled triggers, and cleaning up execution history. The deletion process respects the multi-tenant isolation boundaries and ensures that no residual data or configurations remain that could affect other customers or workflows.

Examples:

Request syntax with placeholder values


resp = client.delete_workflow({
  workflow_arn: "WorkflowArn", # required
  workflow_version: "WorkflowVersion",
})

Response structure


resp.workflow_arn #=> String
resp.workflow_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :workflow_version (String) —

    Optional. The specific version of the workflow to delete. If not specified, all versions of the workflow are deleted.

Returns:

See Also:



674
675
676
677
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 674

def delete_workflow(params = {}, options = {})
  req = build_request(:delete_workflow, params)
  req.send_request(options)
end

#get_task_instance(params = {}) ⇒ Types::GetTaskInstanceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_task_instance({
  workflow_arn: "WorkflowArn", # required
  task_instance_id: "IdString", # required
  run_id: "IdString", # required
})

Response structure


resp.workflow_arn #=> String
resp.run_id #=> String
resp.task_instance_id #=> String
resp.workflow_version #=> String
resp.status #=> String, one of "QUEUED", "FAILED", "SCHEDULED", "RUNNING", "SUCCESS", "UP_FOR_RESCHEDULE", "UP_FOR_RETRY", "UPSTREAM_FAILED", "REMOVED", "RESTARTING", "DEFERRED", "NONE", "CANCELLED", "TIMEOUT"
resp.duration_in_seconds #=> Integer
resp.operator_name #=> String
resp.modified_at #=> Time
resp.ended_at #=> Time
resp.started_at #=> Time
resp.attempt_number #=> Integer
resp.error_message #=> String
resp.task_id #=> String
resp.log_stream #=> String
resp.xcom #=> Hash
resp.xcom["GenericString"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :task_instance_id (required, String) —

    The unique identifier of the task instance to retrieve.

  • :run_id (required, String) —

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

Returns:

See Also:



748
749
750
751
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 748

def get_task_instance(params = {}, options = {})
  req = build_request(:get_task_instance, params)
  req.send_request(options)
end

#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_workflow({
  workflow_arn: "WorkflowArn", # required
  workflow_version: "WorkflowVersion",
})

Response structure


resp.workflow_arn #=> String
resp.workflow_version #=> String
resp.name #=> String
resp.description #=> String
resp.created_at #=> Time
resp.modified_at #=> Time
resp.encryption_configuration.type #=> String, one of "AWS_MANAGED_KEY", "CUSTOMER_MANAGED_KEY"
resp.encryption_configuration.kms_key_id #=> String
resp.logging_configuration.log_group_name #=> String
resp.engine_version #=> Integer
resp.workflow_status #=> String, one of "READY", "DELETING"
resp.definition_s3_location.bucket #=> String
resp.definition_s3_location.object_key #=> String
resp.definition_s3_location.version_id #=> String
resp.schedule_configuration.cron_expression #=> String
resp.role_arn #=> String
resp.network_configuration.security_group_ids #=> Array
resp.network_configuration.security_group_ids[0] #=> String
resp.network_configuration.subnet_ids #=> Array
resp.network_configuration.subnet_ids[0] #=> String
resp.trigger_mode #=> String
resp.workflow_definition #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, 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.

Returns:

See Also:



818
819
820
821
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 818

def get_workflow(params = {}, options = {})
  req = build_request(:get_workflow, params)
  req.send_request(options)
end

#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse

Retrieves detailed information about a specific workflow run, including its status, execution details, and task instances.

Examples:

Request syntax with placeholder values


resp = client.get_workflow_run({
  workflow_arn: "WorkflowArn", # required
  run_id: "IdString", # required
})

Response structure


resp.workflow_arn #=> String
resp.workflow_version #=> String
resp.run_id #=> String
resp.run_type #=> String, one of "ON_DEMAND", "SCHEDULED"
resp.override_parameters #=> Hash
resp.run_detail.workflow_arn #=> String
resp.run_detail.workflow_version #=> String
resp.run_detail.run_id #=> String
resp.run_detail.run_type #=> String, one of "ON_DEMAND", "SCHEDULED"
resp.run_detail.started_on #=> Time
resp.run_detail.created_at #=> Time
resp.run_detail.completed_on #=> Time
resp.run_detail.modified_at #=> Time
resp.run_detail.duration #=> Integer
resp.run_detail.error_message #=> String
resp.run_detail.task_instances #=> Array
resp.run_detail.task_instances[0] #=> String
resp.run_detail.run_state #=> String, one of "STARTING", "QUEUED", "RUNNING", "SUCCESS", "FAILED", "TIMEOUT", "STOPPING", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :run_id (required, String) —

    The unique identifier of the workflow run to retrieve.

Returns:

See Also:



873
874
875
876
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 873

def get_workflow_run(params = {}, options = {})
  req = build_request(:get_workflow_run, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags that are associated with a specified Amazon Managed Workflows for Apache Airflow Serverless resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which to list tags.

Returns:

See Also:



903
904
905
906
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 903

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_task_instances(params = {}) ⇒ Types::ListTaskInstancesResponse

Lists all task instances for a specific workflow run, with optional pagination support.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_task_instances({
  workflow_arn: "WorkflowArn", # required
  run_id: "IdString", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.task_instances #=> Array
resp.task_instances[0].workflow_arn #=> String
resp.task_instances[0].workflow_version #=> String
resp.task_instances[0].run_id #=> String
resp.task_instances[0].task_instance_id #=> String
resp.task_instances[0].status #=> String, one of "QUEUED", "FAILED", "SCHEDULED", "RUNNING", "SUCCESS", "UP_FOR_RESCHEDULE", "UP_FOR_RETRY", "UPSTREAM_FAILED", "REMOVED", "RESTARTING", "DEFERRED", "NONE", "CANCELLED", "TIMEOUT"
resp.task_instances[0].duration_in_seconds #=> Integer
resp.task_instances[0].operator_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :run_id (required, String) —

    The unique identifier of the workflow run for which you want a list of task instances.

  • :max_results (Integer) —

    The maximum number of task instances to return in a single response.

  • :next_token (String) —

    The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ‘ListTaskInstances`.

Returns:

See Also:



958
959
960
961
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 958

def list_task_instances(params = {}, options = {})
  req = build_request(:list_task_instances, params)
  req.send_request(options)
end

#list_workflow_runs(params = {}) ⇒ Types::ListWorkflowRunsResponse

Lists all runs for a specified workflow, with optional pagination and filtering support.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_runs({
  max_results: 1,
  next_token: "String",
  workflow_arn: "WorkflowArn", # required
  workflow_version: "VersionId",
})

Response structure


resp.workflow_runs #=> Array
resp.workflow_runs[0].run_id #=> String
resp.workflow_runs[0].workflow_arn #=> String
resp.workflow_runs[0].workflow_version #=> String
resp.workflow_runs[0].run_type #=> String, one of "ON_DEMAND", "SCHEDULED"
resp.workflow_runs[0].run_detail_summary.status #=> String, one of "STARTING", "QUEUED", "RUNNING", "SUCCESS", "FAILED", "TIMEOUT", "STOPPING", "STOPPED"
resp.workflow_runs[0].run_detail_summary.created_on #=> Time
resp.workflow_runs[0].run_detail_summary.started_at #=> Time
resp.workflow_runs[0].run_detail_summary.ended_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of workflow runs to return in a single response.

  • :next_token (String) —

    The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ‘ListWorkflowRuns`.

  • :workflow_arn (required, String) —

    The Amazon Resource Name (ARN) of the workflow for which you want a list of runs.

  • :workflow_version (String) —

    Optional. The specific version of the workflow for which you want a list of runs. If not specified, runs for all versions are returned.

Returns:

See Also:



1015
1016
1017
1018
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1015

def list_workflow_runs(params = {}, options = {})
  req = build_request(:list_workflow_runs, params)
  req.send_request(options)
end

#list_workflow_versions(params = {}) ⇒ Types::ListWorkflowVersionsResponse

Lists all versions of a specified workflow, with optional pagination support.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflow_versions({
  max_results: 1,
  next_token: "String",
  workflow_arn: "WorkflowArn", # required
})

Response structure


resp.workflow_versions #=> Array
resp.workflow_versions[0].workflow_version #=> String
resp.workflow_versions[0].workflow_arn #=> String
resp.workflow_versions[0].is_latest_version #=> Boolean
resp.workflow_versions[0].created_at #=> Time
resp.workflow_versions[0].modified_at #=> Time
resp.workflow_versions[0].definition_s3_location.bucket #=> String
resp.workflow_versions[0].definition_s3_location.object_key #=> String
resp.workflow_versions[0].definition_s3_location.version_id #=> String
resp.workflow_versions[0].schedule_configuration.cron_expression #=> String
resp.workflow_versions[0].trigger_mode #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of workflow versions to return in a single response.

  • :next_token (String) —

    The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ‘ListWorkflowVersions`.

  • :workflow_arn (required, String) —

    The Amazon Resource Name (ARN) of the workflow for which you want to list versions.

Returns:

See Also:



1070
1071
1072
1073
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1070

def list_workflow_versions(params = {}, options = {})
  req = build_request(:list_workflow_versions, params)
  req.send_request(options)
end

#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse

Lists all workflows in your account, with optional pagination support. This operation returns summary information for workflows, showing only the most recently created version of each workflow. Amazon Managed Workflows for Apache Airflow Serverless maintains workflow metadata in a highly available, distributed storage system that enables efficient querying and filtering. The service implements proper access controls to ensure you can only view workflows that you have permissions to access, supporting both individual and team-based workflow management scenarios.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workflows({
  max_results: 1,
  next_token: "String",
})

Response structure


resp.workflows #=> Array
resp.workflows[0].workflow_arn #=> String
resp.workflows[0].workflow_version #=> String
resp.workflows[0].name #=> String
resp.workflows[0].description #=> String
resp.workflows[0].created_at #=> Time
resp.workflows[0].modified_at #=> Time
resp.workflows[0].workflow_status #=> String, one of "READY", "DELETING"
resp.workflows[0].trigger_mode #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of workflows you want to return in a single response.

  • :next_token (String) —

    The pagination token you need to use to retrieve the next set of results. This value is returned from a previous call to ‘ListWorkflows`.

Returns:

See Also:



1125
1126
1127
1128
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1125

def list_workflows(params = {}, options = {})
  req = build_request(:list_workflows, params)
  req.send_request(options)
end

#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse

Starts a new execution of a workflow. This operation creates a workflow run that executes the tasks that are defined in the workflow. Amazon Managed Workflows for Apache Airflow Serverless schedules the workflow execution across its managed Airflow environment, automatically scaling ECS worker tasks based on the workload. The service handles task isolation, dependency resolution, and provides comprehensive monitoring and logging throughout the execution lifecycle.

Examples:

Request syntax with placeholder values


resp = client.start_workflow_run({
  workflow_arn: "WorkflowArn", # required
  client_token: "IdempotencyTokenString",
  override_parameters: {
    "String" => {
    },
  },
  workflow_version: "VersionId",
})

Response structure


resp.run_id #=> String
resp.status #=> String, one of "STARTING", "QUEUED", "RUNNING", "SUCCESS", "FAILED", "TIMEOUT", "STOPPING", "STOPPED"
resp.started_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :override_parameters (Hash<String,Hash,Array,String,Numeric,Boolean>) —

    Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.

  • :workflow_version (String) —

    Optional. The specific version of the workflow to execute. If not specified, the latest version is used.

Returns:

See Also:



1190
1191
1192
1193
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1190

def start_workflow_run(params = {}, options = {})
  req = build_request(:start_workflow_run, params)
  req.send_request(options)
end

#stop_workflow_run(params = {}) ⇒ Types::StopWorkflowRunResponse

Stops a running workflow execution. This operation terminates all running tasks and prevents new tasks from starting. Amazon Managed Workflows for Apache Airflow Serverless gracefully shuts down the workflow execution by stopping task scheduling and terminating active ECS worker containers. The operation transitions the workflow run to a ‘STOPPING` state and then to `STOPPED` once all cleanup is complete. In-flight tasks may complete or be terminated depending on their current execution state.

Examples:

Request syntax with placeholder values


resp = client.stop_workflow_run({
  workflow_arn: "WorkflowArn", # required
  run_id: "IdString", # required
})

Response structure


resp.workflow_arn #=> String
resp.workflow_version #=> String
resp.run_id #=> String
resp.status #=> String, one of "STARTING", "QUEUED", "RUNNING", "SUCCESS", "FAILED", "TIMEOUT", "STOPPING", "STOPPED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

    The Amazon Resource Name (ARN) of the workflow that contains the run you want to stop.

  • :run_id (required, String) —

    The unique identifier of the workflow run to stop.

Returns:

See Also:



1236
1237
1238
1239
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1236

def stop_workflow_run(params = {}, options = {})
  req = build_request(:stop_workflow_run, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds tags to an Amazon Managed Workflows for Apache Airflow Serverless resource. Tags are key-value pairs that help you organize and categorize your resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to which to add tags.

  • :tags (required, Hash<String,String>) —

    A map of tags to add to the resource. Each tag consists of a key-value pair.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1267
1268
1269
1270
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1267

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from an Amazon Managed Workflows for Apache Airflow Serverless resource. This operation removes the specified tags from the resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

  • :tag_keys (required, Array<String>) —

    A list of tag keys to remove from the resource. Only the keys are required; the values are ignored.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1297
1298
1299
1300
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1297

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_workflow(params = {}) ⇒ Types::UpdateWorkflowResponse

Updates an existing workflow with new configuration settings. This operation allows you to modify the workflow definition, role, and other settings. When you update a workflow, Amazon Managed Workflows for Apache Airflow Serverless automatically creates a new version with the updated configuration and disables scheduling on all previous versions to ensure only one version is actively scheduled at a time. The update operation maintains workflow history while providing a clean transition to the new configuration.

Examples:

Request syntax with placeholder values


resp = client.update_workflow({
  workflow_arn: "WorkflowArn", # required
  definition_s3_location: { # required
    bucket: "String", # required
    object_key: "String", # required
    version_id: "String",
  },
  role_arn: "RoleARN", # required
  description: "DescriptionString",
  logging_configuration: {
    log_group_name: "String", # required
  },
  engine_version: 1,
  network_configuration: {
    security_group_ids: ["SecurityGroupString"],
    subnet_ids: ["SubnetString"],
  },
  trigger_mode: "GenericString",
})

Response structure


resp.workflow_arn #=> String
resp.modified_at #=> Time
resp.workflow_version #=> String
resp.warnings #=> Array
resp.warnings[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workflow_arn (required, String) —

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

  • :definition_s3_location (required, Types::DefinitionS3Location) —

    The Amazon S3 location where the updated workflow definition file is stored.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that Amazon Managed Workflows for Apache Airflow Serverless assumes when it executes the updated workflow.

  • :description (String) —

    An updated description for the workflow.

  • :logging_configuration (Types::LoggingConfiguration) —

    Updated logging configuration for the workflow.

  • :engine_version (Integer) —

    The version of the Amazon Managed Workflows for Apache Airflow Serverless engine that you want to use for the updated workflow.

  • :network_configuration (Types::NetworkConfiguration) —

    Updated network configuration for the workflow execution environment.

  • :trigger_mode (String) —

    The trigger mode for the workflow execution.

Returns:

See Also:



1380
1381
1382
1383
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1380

def update_workflow(params = {}, options = {})
  req = build_request(:update_workflow, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1409
1410
1411
 
# File 'lib/aws-sdk-mwaaserverless/client.rb', line 1409

def waiter_names
  []
end