AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::SES::Model::PutIdentityPolicyRequest Class Reference

#include <PutIdentityPolicyRequest.h>

+ Inheritance diagram for Aws::SES::Model::PutIdentityPolicyRequest:

Public Member Functions

 PutIdentityPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetIdentity () const
 
bool IdentityHasBeenSet () const
 
void SetIdentity (const Aws::String &value)
 
void SetIdentity (Aws::String &&value)
 
void SetIdentity (const char *value)
 
PutIdentityPolicyRequestWithIdentity (const Aws::String &value)
 
PutIdentityPolicyRequestWithIdentity (Aws::String &&value)
 
PutIdentityPolicyRequestWithIdentity (const char *value)
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
PutIdentityPolicyRequestWithPolicyName (const Aws::String &value)
 
PutIdentityPolicyRequestWithPolicyName (Aws::String &&value)
 
PutIdentityPolicyRequestWithPolicyName (const char *value)
 
const Aws::StringGetPolicy () const
 
bool PolicyHasBeenSet () const
 
void SetPolicy (const Aws::String &value)
 
void SetPolicy (Aws::String &&value)
 
void SetPolicy (const char *value)
 
PutIdentityPolicyRequestWithPolicy (const Aws::String &value)
 
PutIdentityPolicyRequestWithPolicy (Aws::String &&value)
 
PutIdentityPolicyRequestWithPolicy (const char *value)
 
- Public Member Functions inherited from Aws::SES::SESRequest
virtual ~SESRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::SES::SESRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

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:

AWS API Reference

Definition at line 28 of file PutIdentityPolicyRequest.h.

Constructor & Destructor Documentation

◆ PutIdentityPolicyRequest()

Aws::SES::Model::PutIdentityPolicyRequest::PutIdentityPolicyRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::SES::Model::PutIdentityPolicyRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetIdentity()

const Aws::String& Aws::SES::Model::PutIdentityPolicyRequest::GetIdentity ( ) const
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 53 of file PutIdentityPolicyRequest.h.

◆ GetPolicy()

const Aws::String& Aws::SES::Model::PutIdentityPolicyRequest::GetPolicy ( ) const
inline

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.

Definition at line 175 of file PutIdentityPolicyRequest.h.

◆ GetPolicyName()

const Aws::String& Aws::SES::Model::PutIdentityPolicyRequest::GetPolicyName ( ) const
inline

The name of the policy.

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

Definition at line 123 of file PutIdentityPolicyRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SES::Model::PutIdentityPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file PutIdentityPolicyRequest.h.

◆ IdentityHasBeenSet()

bool Aws::SES::Model::PutIdentityPolicyRequest::IdentityHasBeenSet ( ) const
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 62 of file PutIdentityPolicyRequest.h.

◆ PolicyHasBeenSet()

bool Aws::SES::Model::PutIdentityPolicyRequest::PolicyHasBeenSet ( ) const
inline

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.

Definition at line 184 of file PutIdentityPolicyRequest.h.

◆ PolicyNameHasBeenSet()

bool Aws::SES::Model::PutIdentityPolicyRequest::PolicyNameHasBeenSet ( ) const
inline

The name of the policy.

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

Definition at line 129 of file PutIdentityPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::SES::Model::PutIdentityPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIdentity() [1/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetIdentity ( const Aws::String value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 71 of file PutIdentityPolicyRequest.h.

◆ SetIdentity() [2/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetIdentity ( Aws::String &&  value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 80 of file PutIdentityPolicyRequest.h.

◆ SetIdentity() [3/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetIdentity ( const char *  value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 89 of file PutIdentityPolicyRequest.h.

◆ SetPolicy() [1/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicy ( const Aws::String value)
inline

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.

Definition at line 193 of file PutIdentityPolicyRequest.h.

◆ SetPolicy() [2/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicy ( Aws::String &&  value)
inline

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.

Definition at line 202 of file PutIdentityPolicyRequest.h.

◆ SetPolicy() [3/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicy ( const char *  value)
inline

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.

Definition at line 211 of file PutIdentityPolicyRequest.h.

◆ SetPolicyName() [1/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicyName ( const Aws::String value)
inline

The name of the policy.

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

Definition at line 135 of file PutIdentityPolicyRequest.h.

◆ SetPolicyName() [2/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicyName ( Aws::String &&  value)
inline

The name of the policy.

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

Definition at line 141 of file PutIdentityPolicyRequest.h.

◆ SetPolicyName() [3/3]

void Aws::SES::Model::PutIdentityPolicyRequest::SetPolicyName ( const char *  value)
inline

The name of the policy.

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

Definition at line 147 of file PutIdentityPolicyRequest.h.

◆ WithIdentity() [1/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithIdentity ( const Aws::String value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 98 of file PutIdentityPolicyRequest.h.

◆ WithIdentity() [2/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithIdentity ( Aws::String &&  value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 107 of file PutIdentityPolicyRequest.h.

◆ WithIdentity() [3/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithIdentity ( const char *  value)
inline

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: user@.nosp@m.exam.nosp@m.ple.c.nosp@m.om, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

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

Definition at line 116 of file PutIdentityPolicyRequest.h.

◆ WithPolicy() [1/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicy ( const Aws::String value)
inline

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.

Definition at line 220 of file PutIdentityPolicyRequest.h.

◆ WithPolicy() [2/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicy ( Aws::String &&  value)
inline

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.

Definition at line 229 of file PutIdentityPolicyRequest.h.

◆ WithPolicy() [3/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicy ( const char *  value)
inline

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.

Definition at line 238 of file PutIdentityPolicyRequest.h.

◆ WithPolicyName() [1/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicyName ( const Aws::String value)
inline

The name of the policy.

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

Definition at line 153 of file PutIdentityPolicyRequest.h.

◆ WithPolicyName() [2/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicyName ( Aws::String &&  value)
inline

The name of the policy.

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

Definition at line 159 of file PutIdentityPolicyRequest.h.

◆ WithPolicyName() [3/3]

PutIdentityPolicyRequest& Aws::SES::Model::PutIdentityPolicyRequest::WithPolicyName ( const char *  value)
inline

The name of the policy.

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

Definition at line 165 of file PutIdentityPolicyRequest.h.


The documentation for this class was generated from the following file: