Skip to content

MWAAServerlessClient#

Index > MWAAServerless > MWAAServerlessClient

Auto-generated documentation for MWAAServerless type annotations stubs module mypy-boto3-mwaa-serverless.

MWAAServerlessClient#

Type annotations and code completion for boto3.client("mwaa-serverless"). boto3 documentation

# MWAAServerlessClient usage example

from boto3.session import Session
from mypy_boto3_mwaa_serverless.client import MWAAServerlessClient

def get_mwaa-serverless_client() -> MWAAServerlessClient:
    return Session().client("mwaa-serverless")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mwaa-serverless").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("mwaa-serverless")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.OperationTimeoutException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mwaa_serverless.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("mwaa-serverless").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("mwaa-serverless").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_workflow#

Creates a new workflow in Amazon Managed Workflows for Apache Airflow Serverless.

Type annotations and code completion for boto3.client("mwaa-serverless").create_workflow method. boto3 documentation

# create_workflow method definition

def create_workflow(
    self,
    *,
    Name: str,
    DefinitionS3Location: DefinitionS3LocationTypeDef,  # (1)
    RoleArn: str,
    ClientToken: str = ...,
    Description: str = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
    LoggingConfiguration: LoggingConfigurationTypeDef = ...,  # (3)
    EngineVersion: int = ...,
    NetworkConfiguration: NetworkConfigurationUnionTypeDef = ...,  # (4)
    Tags: Mapping[str, str] = ...,
    TriggerMode: str = ...,
) -> CreateWorkflowResponseTypeDef:  # (5)
    ...
  1. See DefinitionS3LocationTypeDef
  2. See EncryptionConfigurationTypeDef
  3. See LoggingConfigurationTypeDef
  4. See NetworkConfigurationUnionTypeDef
  5. See CreateWorkflowResponseTypeDef
# create_workflow method usage example with argument unpacking

kwargs: CreateWorkflowRequestTypeDef = {  # (1)
    "Name": ...,
    "DefinitionS3Location": ...,
    "RoleArn": ...,
}

parent.create_workflow(**kwargs)
  1. See CreateWorkflowRequestTypeDef

delete_workflow#

Deletes a workflow and all its versions.

Type annotations and code completion for boto3.client("mwaa-serverless").delete_workflow method. boto3 documentation

# delete_workflow method definition

def delete_workflow(
    self,
    *,
    WorkflowArn: str,
    WorkflowVersion: str = ...,
) -> DeleteWorkflowResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkflowResponseTypeDef
# delete_workflow method usage example with argument unpacking

kwargs: DeleteWorkflowRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
}

parent.delete_workflow(**kwargs)
  1. See DeleteWorkflowRequestTypeDef

get_task_instance#

Retrieves detailed information about a specific task instance within a workflow run.

Type annotations and code completion for boto3.client("mwaa-serverless").get_task_instance method. boto3 documentation

# get_task_instance method definition

def get_task_instance(
    self,
    *,
    WorkflowArn: str,
    TaskInstanceId: str,
    RunId: str,
) -> GetTaskInstanceResponseTypeDef:  # (1)
    ...
  1. See GetTaskInstanceResponseTypeDef
# get_task_instance method usage example with argument unpacking

kwargs: GetTaskInstanceRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
    "TaskInstanceId": ...,
    "RunId": ...,
}

parent.get_task_instance(**kwargs)
  1. See GetTaskInstanceRequestTypeDef

get_workflow#

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

Type annotations and code completion for boto3.client("mwaa-serverless").get_workflow method. boto3 documentation

# get_workflow method definition

def get_workflow(
    self,
    *,
    WorkflowArn: str,
    WorkflowVersion: str = ...,
) -> GetWorkflowResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowResponseTypeDef
# get_workflow method usage example with argument unpacking

kwargs: GetWorkflowRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
}

parent.get_workflow(**kwargs)
  1. See GetWorkflowRequestTypeDef

get_workflow_run#

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

Type annotations and code completion for boto3.client("mwaa-serverless").get_workflow_run method. boto3 documentation

# get_workflow_run method definition

def get_workflow_run(
    self,
    *,
    WorkflowArn: str,
    RunId: str,
) -> GetWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See GetWorkflowRunResponseTypeDef
# get_workflow_run method usage example with argument unpacking

kwargs: GetWorkflowRunRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
    "RunId": ...,
}

parent.get_workflow_run(**kwargs)
  1. See GetWorkflowRunRequestTypeDef

list_tags_for_resource#

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

Type annotations and code completion for boto3.client("mwaa-serverless").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_task_instances#

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

Type annotations and code completion for boto3.client("mwaa-serverless").list_task_instances method. boto3 documentation

# list_task_instances method definition

def list_task_instances(
    self,
    *,
    WorkflowArn: str,
    RunId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTaskInstancesResponseTypeDef:  # (1)
    ...
  1. See ListTaskInstancesResponseTypeDef
# list_task_instances method usage example with argument unpacking

kwargs: ListTaskInstancesRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
    "RunId": ...,
}

parent.list_task_instances(**kwargs)
  1. See ListTaskInstancesRequestTypeDef

list_workflow_runs#

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

Type annotations and code completion for boto3.client("mwaa-serverless").list_workflow_runs method. boto3 documentation

# list_workflow_runs method definition

def list_workflow_runs(
    self,
    *,
    WorkflowArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    WorkflowVersion: str = ...,
) -> ListWorkflowRunsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowRunsResponseTypeDef
# list_workflow_runs method usage example with argument unpacking

kwargs: ListWorkflowRunsRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
}

parent.list_workflow_runs(**kwargs)
  1. See ListWorkflowRunsRequestTypeDef

list_workflow_versions#

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

Type annotations and code completion for boto3.client("mwaa-serverless").list_workflow_versions method. boto3 documentation

# list_workflow_versions method definition

def list_workflow_versions(
    self,
    *,
    WorkflowArn: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWorkflowVersionsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowVersionsResponseTypeDef
# list_workflow_versions method usage example with argument unpacking

kwargs: ListWorkflowVersionsRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
}

parent.list_workflow_versions(**kwargs)
  1. See ListWorkflowVersionsRequestTypeDef

list_workflows#

Lists all workflows in your account, with optional pagination support.

Type annotations and code completion for boto3.client("mwaa-serverless").list_workflows method. boto3 documentation

# list_workflows method definition

def list_workflows(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListWorkflowsResponseTypeDef:  # (1)
    ...
  1. See ListWorkflowsResponseTypeDef
# list_workflows method usage example with argument unpacking

kwargs: ListWorkflowsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_workflows(**kwargs)
  1. See ListWorkflowsRequestTypeDef

start_workflow_run#

Starts a new execution of a workflow.

Type annotations and code completion for boto3.client("mwaa-serverless").start_workflow_run method. boto3 documentation

# start_workflow_run method definition

def start_workflow_run(
    self,
    *,
    WorkflowArn: str,
    ClientToken: str = ...,
    OverrideParameters: Mapping[str, Mapping[str, Any]] = ...,
    WorkflowVersion: str = ...,
) -> StartWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See StartWorkflowRunResponseTypeDef
# start_workflow_run method usage example with argument unpacking

kwargs: StartWorkflowRunRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
}

parent.start_workflow_run(**kwargs)
  1. See StartWorkflowRunRequestTypeDef

stop_workflow_run#

Stops a running workflow execution.

Type annotations and code completion for boto3.client("mwaa-serverless").stop_workflow_run method. boto3 documentation

# stop_workflow_run method definition

def stop_workflow_run(
    self,
    *,
    WorkflowArn: str,
    RunId: str,
) -> StopWorkflowRunResponseTypeDef:  # (1)
    ...
  1. See StopWorkflowRunResponseTypeDef
# stop_workflow_run method usage example with argument unpacking

kwargs: StopWorkflowRunRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
    "RunId": ...,
}

parent.stop_workflow_run(**kwargs)
  1. See StopWorkflowRunRequestTypeDef

tag_resource#

Adds tags to an Amazon Managed Workflows for Apache Airflow Serverless resource.

Type annotations and code completion for boto3.client("mwaa-serverless").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from an Amazon Managed Workflows for Apache Airflow Serverless resource.

Type annotations and code completion for boto3.client("mwaa-serverless").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_workflow#

Updates an existing workflow with new configuration settings.

Type annotations and code completion for boto3.client("mwaa-serverless").update_workflow method. boto3 documentation

# update_workflow method definition

def update_workflow(
    self,
    *,
    WorkflowArn: str,
    DefinitionS3Location: DefinitionS3LocationTypeDef,  # (1)
    RoleArn: str,
    Description: str = ...,
    LoggingConfiguration: LoggingConfigurationTypeDef = ...,  # (2)
    EngineVersion: int = ...,
    NetworkConfiguration: NetworkConfigurationUnionTypeDef = ...,  # (3)
    TriggerMode: str = ...,
) -> UpdateWorkflowResponseTypeDef:  # (4)
    ...
  1. See DefinitionS3LocationTypeDef
  2. See LoggingConfigurationTypeDef
  3. See NetworkConfigurationUnionTypeDef
  4. See UpdateWorkflowResponseTypeDef
# update_workflow method usage example with argument unpacking

kwargs: UpdateWorkflowRequestTypeDef = {  # (1)
    "WorkflowArn": ...,
    "DefinitionS3Location": ...,
    "RoleArn": ...,
}

parent.update_workflow(**kwargs)
  1. See UpdateWorkflowRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("mwaa-serverless").get_paginator method with overloads.