WorkMailMessageFlowClient

Index > WorkMailMessageFlow > WorkMailMessageFlowClient

Auto-generated documentation for WorkMailMessageFlow type annotations stubs module mypy-boto3-workmailmessageflow.

WorkMailMessageFlowClient

Type annotations and code completion for boto3.client("workmailmessageflow"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_workmailmessageflow.client import WorkMailMessageFlowClient

def get_workmailmessageflow_client() -> WorkMailMessageFlowClient:
    return Session().client("workmailmessageflow")

Exceptions

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

Usage example

client = boto3.client("workmailmessageflow")

try:
    do_something(client)
except (
    client.ClientError,
    client.InvalidContentLocation,
    client.MessageFrozen,
    client.MessageRejected,
    client.ResourceNotFoundException,
) as e:
    print(e)

Type checking example

from mypy_boto3_workmailmessageflow.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("workmailmessageflow").can_paginate method. boto3 documentation

Method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("workmailmessageflow").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("workmailmessageflow").generate_presigned_url method. boto3 documentation

Method definition

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

get_raw_message_content

Retrieves the raw content of an in-transit email message, in MIME format.

Type annotations and code completion for boto3.client("workmailmessageflow").get_raw_message_content method. boto3 documentation

Method definition

def get_raw_message_content(
    self,
    *,
    messageId: str,
) -> GetRawMessageContentResponseTypeDef:  # (1)
    ...

1. See GetRawMessageContentResponseTypeDef

Usage example with kwargs

kwargs: GetRawMessageContentRequestRequestTypeDef = {  # (1)
    "messageId": ...,
}

parent.get_raw_message_content(**kwargs)

1. See GetRawMessageContentRequestRequestTypeDef

put_raw_message_content

Updates the raw content of an in-transit email message, in MIME format.

Type annotations and code completion for boto3.client("workmailmessageflow").put_raw_message_content method. boto3 documentation

Method definition

def put_raw_message_content(
    self,
    *,
    messageId: str,
    content: RawMessageContentTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See RawMessageContentTypeDef

Usage example with kwargs

kwargs: PutRawMessageContentRequestRequestTypeDef = {  # (1)
    "messageId": ...,
    "content": ...,
}

parent.put_raw_message_content(**kwargs)

1. See PutRawMessageContentRequestRequestTypeDef