Skip to content

get_identity_notification_attributes

get_identity_notification_attributes(
    identities: IdentityList, *, config_overrides: Optional[SESClientConfig] = None
) -> GetIdentityNotificationAttributesResponse

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

Parameters:

  • identities (IdentityList) –

    A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: [email protected], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

Raises:

Examples:

GetIdentityNotificationAttributes The following example returns the notification attributes for an identity:

>>> client.get_identity_notification_attributes(identities=['example.com'])
Source code in docs_src/capo_ses/_services/ses.py
def get_identity_notification_attributes(
    self,
    identities: "capo_ses.types.identity_list.IdentityList",
    *,
    config_overrides: Optional[SESClientConfig] = None,
) -> "capo_ses.types.get_identity_notification_attributes_response.GetIdentityNotificationAttributesResponse":
    """<p>Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.</p> <p>This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.</p> <p>For more information about using notifications with Amazon SES, see the <a href="https://docs.aws.amazon.com/ses/latest/dg/monitor-sending-activity-using-notifications.html">Amazon SES Developer Guide</a>.</p>

    Args:
        identities: <p>A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: <code>[email protected]</code>, <code>example.com</code>, <code>arn:aws:ses:us-east-1:123456789012:identity/example.com</code>.</p>

    Raises:
        capo_ses.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        GetIdentityNotificationAttributes
        The following example returns the notification attributes for an identity:

        >>> client.get_identity_notification_attributes(identities=['example.com'])
    """

    def _handler(
        req: "OperationRequest[capo_ses.types.get_identity_notification_attributes_request.GetIdentityNotificationAttributesRequest]",
    ) -> OperationResponse[
        "capo_ses.types.get_identity_notification_attributes_response.GetIdentityNotificationAttributesResponse"
    ]:
        import capo_ses._operations.simple_email_service.get_identity_notification_attributes

        output, http_response = (
            capo_ses._operations.simple_email_service.get_identity_notification_attributes.get_identity_notification_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIdentityNotificationAttributes")
    )
    input_: capo_ses.types.get_identity_notification_attributes_request.GetIdentityNotificationAttributesRequest = {
        "identities": identities
    }

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