Skip to content

get_email_identity

get_email_identity(
    email_identity: Identity,
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
) -> GetEmailIdentityResponse

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

Parameters:

  • email_identity (Identity) –

    The email identity that you want to retrieve details for.

Raises:

Source code in docs_src/capo_pinpoint_email/_services/pinpoint_email.py
def get_email_identity(
    self,
    email_identity: "capo_pinpoint_email.types.identity.Identity",
    *,
    config_overrides: Optional[PinpointEmailClientConfig] = None,
) -> (
    "capo_pinpoint_email.types.get_email_identity_response.GetEmailIdentityResponse"
):
    """<p>Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.</p>

    Args:
        email_identity: <p>The email identity that you want to retrieve details for.</p>

    Raises:
        capo_pinpoint_email.errors.bad_request_exception.BadRequestException: <p>The input you provided is invalid.</p>
        capo_pinpoint_email.errors.not_found_exception.NotFoundException: <p>The resource you attempted to access doesn't exist.</p>
        capo_pinpoint_email.errors.too_many_requests_exception.TooManyRequestsException: <p>Too many requests have been made to the operation.</p>
        capo_pinpoint_email.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_pinpoint_email.types.get_email_identity_request.GetEmailIdentityRequest]",
    ) -> OperationResponse[
        "capo_pinpoint_email.types.get_email_identity_response.GetEmailIdentityResponse"
    ]:
        import capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_email_identity

        output, http_response = (
            capo_pinpoint_email._operations.amazon_pinpoint_email_service.get_email_identity.get_email_identity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEmailIdentity")
    )
    input_: capo_pinpoint_email.types.get_email_identity_request.GetEmailIdentityRequest = {
        "email_identity": email_identity
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output