AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::UpdateGroupRequest Class Reference

#include <UpdateGroupRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::UpdateGroupRequest:

Public Member Functions

 UpdateGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGroupName () const
 
bool GroupNameHasBeenSet () const
 
void SetGroupName (const Aws::String &value)
 
void SetGroupName (Aws::String &&value)
 
void SetGroupName (const char *value)
 
UpdateGroupRequestWithGroupName (const Aws::String &value)
 
UpdateGroupRequestWithGroupName (Aws::String &&value)
 
UpdateGroupRequestWithGroupName (const char *value)
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
UpdateGroupRequestWithUserPoolId (const Aws::String &value)
 
UpdateGroupRequestWithUserPoolId (Aws::String &&value)
 
UpdateGroupRequestWithUserPoolId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateGroupRequestWithDescription (const Aws::String &value)
 
UpdateGroupRequestWithDescription (Aws::String &&value)
 
UpdateGroupRequestWithDescription (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
UpdateGroupRequestWithRoleArn (const Aws::String &value)
 
UpdateGroupRequestWithRoleArn (Aws::String &&value)
 
UpdateGroupRequestWithRoleArn (const char *value)
 
int GetPrecedence () const
 
bool PrecedenceHasBeenSet () const
 
void SetPrecedence (int value)
 
UpdateGroupRequestWithPrecedence (int value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file UpdateGroupRequest.h.

Constructor & Destructor Documentation

◆ UpdateGroupRequest()

Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::UpdateGroupRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::DescriptionHasBeenSet ( ) const
inline

A string containing the new description of the group.

Definition at line 127 of file UpdateGroupRequest.h.

◆ GetDescription()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetDescription ( ) const
inline

A string containing the new description of the group.

Definition at line 122 of file UpdateGroupRequest.h.

◆ GetGroupName()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetGroupName ( ) const
inline

The name of the group.

Definition at line 40 of file UpdateGroupRequest.h.

◆ GetPrecedence()

int Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetPrecedence ( ) const
inline

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Definition at line 222 of file UpdateGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoleArn()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetRoleArn ( ) const
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 165 of file UpdateGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdateGroupRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool.

Definition at line 81 of file UpdateGroupRequest.h.

◆ GroupNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::GroupNameHasBeenSet ( ) const
inline

The name of the group.

Definition at line 45 of file UpdateGroupRequest.h.

◆ PrecedenceHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::PrecedenceHasBeenSet ( ) const
inline

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Definition at line 229 of file UpdateGroupRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::RoleArnHasBeenSet ( ) const
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 172 of file UpdateGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetDescription ( Aws::String &&  value)
inline

A string containing the new description of the group.

Definition at line 137 of file UpdateGroupRequest.h.

◆ SetDescription() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetDescription ( const Aws::String value)
inline

A string containing the new description of the group.

Definition at line 132 of file UpdateGroupRequest.h.

◆ SetDescription() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetDescription ( const char *  value)
inline

A string containing the new description of the group.

Definition at line 142 of file UpdateGroupRequest.h.

◆ SetGroupName() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetGroupName ( Aws::String &&  value)
inline

The name of the group.

Definition at line 55 of file UpdateGroupRequest.h.

◆ SetGroupName() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetGroupName ( const Aws::String value)
inline

The name of the group.

Definition at line 50 of file UpdateGroupRequest.h.

◆ SetGroupName() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetGroupName ( const char *  value)
inline

The name of the group.

Definition at line 60 of file UpdateGroupRequest.h.

◆ SetPrecedence()

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetPrecedence ( int  value)
inline

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Definition at line 236 of file UpdateGroupRequest.h.

◆ SetRoleArn() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetRoleArn ( Aws::String &&  value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 186 of file UpdateGroupRequest.h.

◆ SetRoleArn() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetRoleArn ( const Aws::String value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 179 of file UpdateGroupRequest.h.

◆ SetRoleArn() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetRoleArn ( const char *  value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 193 of file UpdateGroupRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 96 of file UpdateGroupRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 91 of file UpdateGroupRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 101 of file UpdateGroupRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool.

Definition at line 86 of file UpdateGroupRequest.h.

◆ WithDescription() [1/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithDescription ( Aws::String &&  value)
inline

A string containing the new description of the group.

Definition at line 152 of file UpdateGroupRequest.h.

◆ WithDescription() [2/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithDescription ( const Aws::String value)
inline

A string containing the new description of the group.

Definition at line 147 of file UpdateGroupRequest.h.

◆ WithDescription() [3/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithDescription ( const char *  value)
inline

A string containing the new description of the group.

Definition at line 157 of file UpdateGroupRequest.h.

◆ WithGroupName() [1/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithGroupName ( Aws::String &&  value)
inline

The name of the group.

Definition at line 70 of file UpdateGroupRequest.h.

◆ WithGroupName() [2/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithGroupName ( const Aws::String value)
inline

The name of the group.

Definition at line 65 of file UpdateGroupRequest.h.

◆ WithGroupName() [3/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithGroupName ( const char *  value)
inline

The name of the group.

Definition at line 75 of file UpdateGroupRequest.h.

◆ WithPrecedence()

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithPrecedence ( int  value)
inline

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Definition at line 243 of file UpdateGroupRequest.h.

◆ WithRoleArn() [1/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithRoleArn ( Aws::String &&  value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 207 of file UpdateGroupRequest.h.

◆ WithRoleArn() [2/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithRoleArn ( const Aws::String value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 200 of file UpdateGroupRequest.h.

◆ WithRoleArn() [3/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithRoleArn ( const char *  value)
inline

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Definition at line 214 of file UpdateGroupRequest.h.

◆ WithUserPoolId() [1/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 111 of file UpdateGroupRequest.h.

◆ WithUserPoolId() [2/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 106 of file UpdateGroupRequest.h.

◆ WithUserPoolId() [3/3]

UpdateGroupRequest& Aws::CognitoIdentityProvider::Model::UpdateGroupRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 116 of file UpdateGroupRequest.h.


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