create_addon_instance `async` ¶

create_addon_instance(
    addon_subscription_id: AddonSubscriptionId,
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
    tags: Optional[TagList] = None,
) -> CreateAddonInstanceResponse

Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy.

Parameters:

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

A unique token that Amazon SES uses to recognize subsequent retries of the same request.
addon_subscription_id (AddonSubscriptionId) –

The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.
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:

ConflictException –

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

Occurs when a requested resource is not found.
ServiceQuotaExceededException –

Occurs when an operation exceeds a predefined service quota or limit.
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_addon_instance(
    self,
    addon_subscription_id: "capo_mailmanager.types.addon_subscription_id.AddonSubscriptionId",
    *,
    config_overrides: Optional[AsyncMailManagerClientConfig] = None,
    client_token: Optional[
        "capo_mailmanager.types.idempotency_token.IdempotencyToken"
    ] = None,
    tags: Optional["capo_mailmanager.types.tag_list.TagList"] = None,
) -> "capo_mailmanager.types.create_addon_instance_response.CreateAddonInstanceResponse":
    """<p>Creates an Add On instance for the subscription indicated in the request. The resulting Amazon Resource Name (ARN) can be used in a conditional statement for a rule set or traffic policy. </p>

    Args:
        client_token: <p>A unique token that Amazon SES uses to recognize subsequent retries of the same request.</p>
        addon_subscription_id: <p>The unique ID of a previously created subscription that an Add On instance is created for. You can only have one instance per subscription.</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.conflict_exception.ConflictException: <p>The request configuration has conflicts. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</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.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_addon_instance_request.CreateAddonInstanceRequest]",
    ) -> AsyncOperationResponse[
        "capo_mailmanager.types.create_addon_instance_response.CreateAddonInstanceResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.create_addon_instance

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateAddonInstance")
    )
    input_: capo_mailmanager.types.create_addon_instance_request.CreateAddonInstanceRequest = {
        "addon_subscription_id": addon_subscription_id
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    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_addon_instance async ¶

create_addon_instance `async` ¶