libZSservicesZSamazonka-sesZSamazonka-ses
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SES.GetIdentityPolicies

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.

Synopsis

Creating a Request

data GetIdentityPolicies Source #

Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

See: newGetIdentityPolicies smart constructor.

Constructors

GetIdentityPolicies' 

Fields

  • identity :: Text

    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: 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.

  • policyNames :: [Text]

    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 ListIdentityPolicies.

Instances

Instances details
Eq GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Read GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Show GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Generic GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Associated Types

type Rep GetIdentityPolicies :: Type -> Type #

NFData GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Methods

rnf :: GetIdentityPolicies -> () #

Hashable GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

AWSRequest GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Associated Types

type AWSResponse GetIdentityPolicies #

ToHeaders GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

ToPath GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

ToQuery GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

type Rep GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

type Rep GetIdentityPolicies = D1 ('MetaData "GetIdentityPolicies" "Amazonka.SES.GetIdentityPolicies" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "GetIdentityPolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))
type AWSResponse GetIdentityPolicies Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

newGetIdentityPolicies Source #

Create a value of GetIdentityPolicies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identity:GetIdentityPolicies', getIdentityPolicies_identity - 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: 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.

$sel:policyNames:GetIdentityPolicies', getIdentityPolicies_policyNames - 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 ListIdentityPolicies.

Request Lenses

getIdentityPolicies_identity :: Lens' GetIdentityPolicies Text Source #

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: 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.

getIdentityPolicies_policyNames :: Lens' GetIdentityPolicies [Text] Source #

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 ListIdentityPolicies.

Destructuring the Response

data GetIdentityPoliciesResponse Source #

Represents the requested sending authorization policies.

See: newGetIdentityPoliciesResponse smart constructor.

Constructors

GetIdentityPoliciesResponse' 

Fields

Instances

Instances details
Eq GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Read GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Show GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Generic GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

Associated Types

type Rep GetIdentityPoliciesResponse :: Type -> Type #

NFData GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

type Rep GetIdentityPoliciesResponse Source # 
Instance details

Defined in Amazonka.SES.GetIdentityPolicies

type Rep GetIdentityPoliciesResponse = D1 ('MetaData "GetIdentityPoliciesResponse" "Amazonka.SES.GetIdentityPolicies" "libZSservicesZSamazonka-sesZSamazonka-ses" 'False) (C1 ('MetaCons "GetIdentityPoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newGetIdentityPoliciesResponse Source #

Create a value of GetIdentityPoliciesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:GetIdentityPoliciesResponse', getIdentityPoliciesResponse_httpStatus - The response's http status code.

$sel:policies:GetIdentityPoliciesResponse', getIdentityPoliciesResponse_policies - A map of policy names to policies.

Response Lenses