create_archive `async` ¶

create_archive(
    archive_name: ArchiveNameString,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    retention: Optional[ArchiveRetention] = None,
    kms_key_arn: Optional[KmsKeyArn] = None,
    tags: Optional[TagList] = None,
) -> CreateArchiveResponse

Creates a new email archive resource for storing and retaining emails.

Parameters:

client_token (Optional[IdempotencyToken], default: None ) –

A unique token Amazon SES uses to recognize retries of this request.
archive_name (ArchiveNameString) –

A unique name for the new archive.
retention (Optional[ArchiveRetention], default: None ) –

The period for retaining emails in the archive before automatic deletion.
kms_key_arn (Optional[KmsKeyArn], default: None ) –

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.
tags (Optional[TagList], default: None ) –

The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Raises:

AccessDeniedException –

Occurs when a user is denied access to a specific resource or action.
ConflictException –

The request configuration has conflicts. For details, see the accompanying error message.
ServiceQuotaExceededException –

Occurs when an operation exceeds a predefined service quota or limit.
ThrottlingException –

Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.
ValidationException –

The request validation has failed. For details, see the accompanying error message.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_mailmanager/_services/async_mail_manager.py

async def create_archive(
    self,
    archive_name: "capo_mailmanager.types.archive_name_string.ArchiveNameString",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    retention: Optional[
        "capo_mailmanager.types.archive_retention.ArchiveRetention"
    ] = None,
    kms_key_arn: Optional["capo_mailmanager.types.kms_key_arn.KmsKeyArn"] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_archive_response.CreateArchiveResponse":
    """<p>Creates a new email archive resource for storing and retaining emails.</p>

    Args:
        client_token: <p>A unique token Amazon SES uses to recognize retries of this request.</p>
        archive_name: <p>A unique name for the new archive.</p>
        retention: <p>The period for retaining emails in the archive before automatic deletion.</p>
        kms_key_arn: <p>The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.</p>
        tags: <p>The tags used to organize, track, or control access for the resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>

    Raises:
        capo_mailmanager.errors.access_denied_exception.AccessDeniedException: <p>Occurs when a user is denied access to a specific resource or action.</p>
        capo_mailmanager.errors.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Occurs when an operation exceeds a predefined service quota or limit.</p>
        capo_mailmanager.errors.throttling_exception.ThrottlingException: <p>Occurs when a service's request rate limit is exceeded, resulting in throttling of further requests.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_mailmanager.types.create_archive_request.CreateArchiveRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.create_archive_response.CreateArchiveResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_archive

        (
            output,
            http_response,
        ) = await capo_mailmanager._operations.mail_manager_svc.create_archive.async_create_archive(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateArchive")
    )
    input_: capo_mailmanager.types.create_archive_request.CreateArchiveRequest = {
        "archive_name": archive_name
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if retention is not None:
        input_["retention"] = retention
    if kms_key_arn is not None:
        input_["kms_key_arn"] = kms_key_arn
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

create_archive async ¶

create_archive `async` ¶