list_identity_policies

list_identity_policies(**kwargs)

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies .

Note

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

You can execute this operation no more than once per second.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_policies(
    Identity='string'
)

Parameters

Identity (string) --

[REQUIRED]

The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com , example.com , arn:aws:ses:us-east-1:123456789012:identity/example.com .

To successfully call this API, you must own the identity.

Return type

dict

Returns

Response Syntax

{
    'PolicyNames': [
        'string',
    ]
}

Response Structure

• (dict) --

  A list of names of sending authorization policies that apply to an identity.

  • PolicyNames (list) --

    A list of names of policies that apply to the specified identity.

    • (string) --

Examples

The following example returns a list of sending authorization policies that are attached to an identity:

response = client.list_identity_policies(
    Identity='example.com',
)

print(response)

Expected Output:

{
    'PolicyNames': [
        'MyPolicy',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}