paws.customer.engagement (version 0.1.12)

ses_get_identity_policies: Returns the requested sending authorization policies for the given identity (an email address or a domain)

Description

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

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.

Usage

ses_get_identity_policies(Identity, PolicyNames)

Value

A list with the following syntax:

list(
  Policies = list(
    "string"
  )
)

Arguments

Identity

[required] The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: [e-mail], example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

PolicyNames

[required] A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use list_identity_policies.

Request syntax

svc$get_identity_policies(
  Identity = "string",
  PolicyNames = list(
    "string"
  )
)

Examples

if (FALSE) {
# The following example returns a sending authorization policy for an
# identity:
svc$get_identity_policies(
  Identity = "example.com",
  PolicyNames = list(
    "MyPolicy"
  )
)
}