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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ses/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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2986
2987
2988
2989
2990
2991
2992
 
# File 'gems/aws-sdk-ses/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.

Returns:

  • (String) 


2986
2987
2988
2989
2990
2991
2992
 
# File 'gems/aws-sdk-ses/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) 


2986
2987
2988
2989
2990
2991
2992
 
# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 2986

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