Class: Aws::SES::Types::PutIdentityPolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::SES::Types::PutIdentityPolicyRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ses/types.rb

Overview

Represents a request to add or update a sending authorization policy 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].

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #identity ⇒ String

  The identity to which that the policy applies.

• #policy ⇒ String

  The text of the policy in JSON format.

• #policy_name ⇒ String

  The name of the policy.

Instance Attribute Details

#identity ⇒ String

The identity to which that the policy applies. 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 operation, you must own the identity.

Returns:

• (String)

# File 'lib/aws-sdk-ses/types.rb', line 2986

class PutIdentityPolicyRequest < Struct.new(
  :identity,
  :policy_name,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the [Amazon SES Developer Guide].

[1]: docs.aws.amazon.com/ses/latest/dg/sending-authorization-policies.html

Returns:

• (String)

# File 'lib/aws-sdk-ses/types.rb', line 2986

class PutIdentityPolicyRequest < Struct.new(
  :identity,
  :policy_name,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end

#policy_name ⇒ String

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

Returns:

• (String)

# File 'lib/aws-sdk-ses/types.rb', line 2986

class PutIdentityPolicyRequest < Struct.new(
  :identity,
  :policy_name,
  :policy)
  SENSITIVE = []
  include Aws::Structure
end