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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass PutIdentityPolicyRequest data as a hash:

{
  identity: "Identity", # required
  policy_name: "PolicyName", # required
  policy: "Policy", # required
}

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/DeveloperGuide/sending-authorization.html

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#identity ⇒ String

The identity that the policy will apply to. 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`.

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

Returns:

  • (String) 


2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-ses/types.rb', line 2953

class PutIdentityPolicyRequest < Struct.new(
  :identity,
  :policy_name,
  :policy)
  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/DeveloperGuide/sending-authorization-policies.html

Returns:

  • (String) 


2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-ses/types.rb', line 2953

class PutIdentityPolicyRequest < Struct.new(
  :identity,
  :policy_name,
  :policy)
  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) 


2953
2954
2955
2956
2957
2958
 
# File 'lib/aws-sdk-ses/types.rb', line 2953

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