update_email_address_metadata async ¶

async def update_email_address_metadata(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    email_address_id: "capo_connect.types.email_address_id.EmailAddressId",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
    description: Optional["capo_connect.types.description.Description"] = None,
    display_name: Optional[
        "capo_connect.types.email_address_display_name.EmailAddressDisplayName"
    ] = None,
    client_token: Optional["capo_connect.types.client_token.ClientToken"] = None,
) -> "capo_connect.types.update_email_address_metadata_response.UpdateEmailAddressMetadataResponse":
    """<p>Updates an email address metadata. For more information about email addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html">Create email addresses</a> in the Connect Customer Administrator Guide.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        email_address_id: <p>The identifier of the email address.</p>
        description: <p>The description of the email address.</p>
        display_name: <p>The display name of email address.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>

    Raises:
        capo_connect.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_connect.errors.idempotency_exception.IdempotencyException: <p>An entity with the same name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.update_email_address_metadata_request.UpdateEmailAddressMetadataRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.update_email_address_metadata_response.UpdateEmailAddressMetadataResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.update_email_address_metadata

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.update_email_address_metadata.async_update_email_address_metadata(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connect.types.update_email_address_metadata_request.UpdateEmailAddressMetadataRequest",
    ) -> dict[str, Any]:
        import capo_connect.types.update_email_address_metadata_request

        return capo_connect.types.update_email_address_metadata_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateEmailAddressMetadata", redact_input=_redact_input),
    )
    input_: capo_connect.types.update_email_address_metadata_request.UpdateEmailAddressMetadataRequest = {
        "instance_id": instance_id,
        "email_address_id": email_address_id,
    }
    if description is not None:
        input_["description"] = description
    if display_name is not None:
        input_["display_name"] = display_name
    if client_token is not None:
        input_["client_token"] = client_token

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