AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::PutMethodRequest Class Reference

#include <PutMethodRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::PutMethodRequest:

Public Member Functions

 PutMethodRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
PutMethodRequestWithRestApiId (const Aws::String &value)
 
PutMethodRequestWithRestApiId (Aws::String &&value)
 
PutMethodRequestWithRestApiId (const char *value)
 
const Aws::StringGetResourceId () const
 
bool ResourceIdHasBeenSet () const
 
void SetResourceId (const Aws::String &value)
 
void SetResourceId (Aws::String &&value)
 
void SetResourceId (const char *value)
 
PutMethodRequestWithResourceId (const Aws::String &value)
 
PutMethodRequestWithResourceId (Aws::String &&value)
 
PutMethodRequestWithResourceId (const char *value)
 
const Aws::StringGetHttpMethod () const
 
bool HttpMethodHasBeenSet () const
 
void SetHttpMethod (const Aws::String &value)
 
void SetHttpMethod (Aws::String &&value)
 
void SetHttpMethod (const char *value)
 
PutMethodRequestWithHttpMethod (const Aws::String &value)
 
PutMethodRequestWithHttpMethod (Aws::String &&value)
 
PutMethodRequestWithHttpMethod (const char *value)
 
const Aws::StringGetAuthorizationType () const
 
bool AuthorizationTypeHasBeenSet () const
 
void SetAuthorizationType (const Aws::String &value)
 
void SetAuthorizationType (Aws::String &&value)
 
void SetAuthorizationType (const char *value)
 
PutMethodRequestWithAuthorizationType (const Aws::String &value)
 
PutMethodRequestWithAuthorizationType (Aws::String &&value)
 
PutMethodRequestWithAuthorizationType (const char *value)
 
const Aws::StringGetAuthorizerId () const
 
bool AuthorizerIdHasBeenSet () const
 
void SetAuthorizerId (const Aws::String &value)
 
void SetAuthorizerId (Aws::String &&value)
 
void SetAuthorizerId (const char *value)
 
PutMethodRequestWithAuthorizerId (const Aws::String &value)
 
PutMethodRequestWithAuthorizerId (Aws::String &&value)
 
PutMethodRequestWithAuthorizerId (const char *value)
 
bool GetApiKeyRequired () const
 
bool ApiKeyRequiredHasBeenSet () const
 
void SetApiKeyRequired (bool value)
 
PutMethodRequestWithApiKeyRequired (bool value)
 
const Aws::StringGetOperationName () const
 
bool OperationNameHasBeenSet () const
 
void SetOperationName (const Aws::String &value)
 
void SetOperationName (Aws::String &&value)
 
void SetOperationName (const char *value)
 
PutMethodRequestWithOperationName (const Aws::String &value)
 
PutMethodRequestWithOperationName (Aws::String &&value)
 
PutMethodRequestWithOperationName (const char *value)
 
const Aws::Map< Aws::String, bool > & GetRequestParameters () const
 
bool RequestParametersHasBeenSet () const
 
void SetRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
void SetRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
PutMethodRequestWithRequestParameters (const Aws::Map< Aws::String, bool > &value)
 
PutMethodRequestWithRequestParameters (Aws::Map< Aws::String, bool > &&value)
 
PutMethodRequestAddRequestParameters (const Aws::String &key, bool value)
 
PutMethodRequestAddRequestParameters (Aws::String &&key, bool value)
 
PutMethodRequestAddRequestParameters (const char *key, bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetRequestModels () const
 
bool RequestModelsHasBeenSet () const
 
void SetRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
PutMethodRequestWithRequestModels (const Aws::Map< Aws::String, Aws::String > &value)
 
PutMethodRequestWithRequestModels (Aws::Map< Aws::String, Aws::String > &&value)
 
PutMethodRequestAddRequestModels (const Aws::String &key, const Aws::String &value)
 
PutMethodRequestAddRequestModels (Aws::String &&key, const Aws::String &value)
 
PutMethodRequestAddRequestModels (const Aws::String &key, Aws::String &&value)
 
PutMethodRequestAddRequestModels (Aws::String &&key, Aws::String &&value)
 
PutMethodRequestAddRequestModels (const char *key, Aws::String &&value)
 
PutMethodRequestAddRequestModels (Aws::String &&key, const char *value)
 
PutMethodRequestAddRequestModels (const char *key, const char *value)
 
const Aws::StringGetRequestValidatorId () const
 
bool RequestValidatorIdHasBeenSet () const
 
void SetRequestValidatorId (const Aws::String &value)
 
void SetRequestValidatorId (Aws::String &&value)
 
void SetRequestValidatorId (const char *value)
 
PutMethodRequestWithRequestValidatorId (const Aws::String &value)
 
PutMethodRequestWithRequestValidatorId (Aws::String &&value)
 
PutMethodRequestWithRequestValidatorId (const char *value)
 
const Aws::Vector< Aws::String > & GetAuthorizationScopes () const
 
bool AuthorizationScopesHasBeenSet () const
 
void SetAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
void SetAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
PutMethodRequestWithAuthorizationScopes (const Aws::Vector< Aws::String > &value)
 
PutMethodRequestWithAuthorizationScopes (Aws::Vector< Aws::String > &&value)
 
PutMethodRequestAddAuthorizationScopes (const Aws::String &value)
 
PutMethodRequestAddAuthorizationScopes (Aws::String &&value)
 
PutMethodRequestAddAuthorizationScopes (const char *value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Request to add a method to an existing Resource resource.

See Also:

AWS API Reference

Definition at line 27 of file PutMethodRequest.h.

Constructor & Destructor Documentation

◆ PutMethodRequest()

Aws::APIGateway::Model::PutMethodRequest::PutMethodRequest ( )

Member Function Documentation

◆ AddAuthorizationScopes() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddAuthorizationScopes ( const Aws::String value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 713 of file PutMethodRequest.h.

◆ AddAuthorizationScopes() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddAuthorizationScopes ( Aws::String &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 725 of file PutMethodRequest.h.

◆ AddAuthorizationScopes() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddAuthorizationScopes ( const char *  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 737 of file PutMethodRequest.h.

◆ AddRequestModels() [1/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( const Aws::String key,
const Aws::String value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 537 of file PutMethodRequest.h.

◆ AddRequestModels() [2/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( Aws::String &&  key,
const Aws::String value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 544 of file PutMethodRequest.h.

◆ AddRequestModels() [3/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( const Aws::String key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 551 of file PutMethodRequest.h.

◆ AddRequestModels() [4/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 558 of file PutMethodRequest.h.

◆ AddRequestModels() [5/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( const char *  key,
Aws::String &&  value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 565 of file PutMethodRequest.h.

◆ AddRequestModels() [6/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( Aws::String &&  key,
const char *  value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 572 of file PutMethodRequest.h.

◆ AddRequestModels() [7/7]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestModels ( const char *  key,
const char *  value 
)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 579 of file PutMethodRequest.h.

◆ AddRequestParameters() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestParameters ( const Aws::String key,
bool  value 
)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 461 of file PutMethodRequest.h.

◆ AddRequestParameters() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestParameters ( Aws::String &&  key,
bool  value 
)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 474 of file PutMethodRequest.h.

◆ AddRequestParameters() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::AddRequestParameters ( const char *  key,
bool  value 
)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 487 of file PutMethodRequest.h.

◆ ApiKeyRequiredHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::ApiKeyRequiredHasBeenSet ( ) const
inline

Specifies whether the method required a valid ApiKey.

Definition at line 302 of file PutMethodRequest.h.

◆ AuthorizationScopesHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::AuthorizationScopesHasBeenSet ( ) const
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 653 of file PutMethodRequest.h.

◆ AuthorizationTypeHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::AuthorizationTypeHasBeenSet ( ) const
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 186 of file PutMethodRequest.h.

◆ AuthorizerIdHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::AuthorizerIdHasBeenSet ( ) const
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 249 of file PutMethodRequest.h.

◆ GetApiKeyRequired()

bool Aws::APIGateway::Model::PutMethodRequest::GetApiKeyRequired ( ) const
inline

Specifies whether the method required a valid ApiKey.

Definition at line 297 of file PutMethodRequest.h.

◆ GetAuthorizationScopes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::PutMethodRequest::GetAuthorizationScopes ( ) const
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 641 of file PutMethodRequest.h.

◆ GetAuthorizationType()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetAuthorizationType ( ) const
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 178 of file PutMethodRequest.h.

◆ GetAuthorizerId()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetAuthorizerId ( ) const
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 242 of file PutMethodRequest.h.

◆ GetHttpMethod()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetHttpMethod ( ) const
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 134 of file PutMethodRequest.h.

◆ GetOperationName()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetOperationName ( ) const
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 320 of file PutMethodRequest.h.

◆ GetRequestModels()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::PutMethodRequest::GetRequestModels ( ) const
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 495 of file PutMethodRequest.h.

◆ GetRequestParameters()

const Aws::Map<Aws::String, bool>& Aws::APIGateway::Model::PutMethodRequest::GetRequestParameters ( ) const
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 383 of file PutMethodRequest.h.

◆ GetRequestValidatorId()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetRequestValidatorId ( ) const
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 586 of file PutMethodRequest.h.

◆ GetResourceId()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetResourceId ( ) const
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 86 of file PutMethodRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::PutMethodRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 44 of file PutMethodRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::PutMethodRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file PutMethodRequest.h.

◆ HttpMethodHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::HttpMethodHasBeenSet ( ) const
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 139 of file PutMethodRequest.h.

◆ OperationNameHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::OperationNameHasBeenSet ( ) const
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 327 of file PutMethodRequest.h.

◆ RequestModelsHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::RequestModelsHasBeenSet ( ) const
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 502 of file PutMethodRequest.h.

◆ RequestParametersHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::RequestParametersHasBeenSet ( ) const
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 396 of file PutMethodRequest.h.

◆ RequestValidatorIdHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::RequestValidatorIdHasBeenSet ( ) const
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 592 of file PutMethodRequest.h.

◆ ResourceIdHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::ResourceIdHasBeenSet ( ) const
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 92 of file PutMethodRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::PutMethodRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 49 of file PutMethodRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::PutMethodRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiKeyRequired()

void Aws::APIGateway::Model::PutMethodRequest::SetApiKeyRequired ( bool  value)
inline

Specifies whether the method required a valid ApiKey.

Definition at line 307 of file PutMethodRequest.h.

◆ SetAuthorizationScopes() [1/2]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizationScopes ( const Aws::Vector< Aws::String > &  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 665 of file PutMethodRequest.h.

◆ SetAuthorizationScopes() [2/2]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizationScopes ( Aws::Vector< Aws::String > &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 677 of file PutMethodRequest.h.

◆ SetAuthorizationType() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizationType ( const Aws::String value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 194 of file PutMethodRequest.h.

◆ SetAuthorizationType() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizationType ( Aws::String &&  value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 202 of file PutMethodRequest.h.

◆ SetAuthorizationType() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizationType ( const char *  value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 210 of file PutMethodRequest.h.

◆ SetAuthorizerId() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizerId ( const Aws::String value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 256 of file PutMethodRequest.h.

◆ SetAuthorizerId() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizerId ( Aws::String &&  value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 263 of file PutMethodRequest.h.

◆ SetAuthorizerId() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetAuthorizerId ( const char *  value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 270 of file PutMethodRequest.h.

◆ SetHttpMethod() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetHttpMethod ( const Aws::String value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 144 of file PutMethodRequest.h.

◆ SetHttpMethod() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetHttpMethod ( Aws::String &&  value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 149 of file PutMethodRequest.h.

◆ SetHttpMethod() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetHttpMethod ( const char *  value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 154 of file PutMethodRequest.h.

◆ SetOperationName() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetOperationName ( const Aws::String value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 334 of file PutMethodRequest.h.

◆ SetOperationName() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetOperationName ( Aws::String &&  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 341 of file PutMethodRequest.h.

◆ SetOperationName() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetOperationName ( const char *  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 348 of file PutMethodRequest.h.

◆ SetRequestModels() [1/2]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestModels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 509 of file PutMethodRequest.h.

◆ SetRequestModels() [2/2]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 516 of file PutMethodRequest.h.

◆ SetRequestParameters() [1/2]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestParameters ( const Aws::Map< Aws::String, bool > &  value)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 409 of file PutMethodRequest.h.

◆ SetRequestParameters() [2/2]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestParameters ( Aws::Map< Aws::String, bool > &&  value)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 422 of file PutMethodRequest.h.

◆ SetRequestValidatorId() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestValidatorId ( const Aws::String value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 598 of file PutMethodRequest.h.

◆ SetRequestValidatorId() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestValidatorId ( Aws::String &&  value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 604 of file PutMethodRequest.h.

◆ SetRequestValidatorId() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRequestValidatorId ( const char *  value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 610 of file PutMethodRequest.h.

◆ SetResourceId() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetResourceId ( const Aws::String value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 98 of file PutMethodRequest.h.

◆ SetResourceId() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetResourceId ( Aws::String &&  value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 104 of file PutMethodRequest.h.

◆ SetResourceId() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetResourceId ( const char *  value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 110 of file PutMethodRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 54 of file PutMethodRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 59 of file PutMethodRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::PutMethodRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 64 of file PutMethodRequest.h.

◆ WithApiKeyRequired()

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithApiKeyRequired ( bool  value)
inline

Specifies whether the method required a valid ApiKey.

Definition at line 312 of file PutMethodRequest.h.

◆ WithAuthorizationScopes() [1/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizationScopes ( const Aws::Vector< Aws::String > &  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 689 of file PutMethodRequest.h.

◆ WithAuthorizationScopes() [2/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizationScopes ( Aws::Vector< Aws::String > &&  value)
inline

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Definition at line 701 of file PutMethodRequest.h.

◆ WithAuthorizationType() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizationType ( const Aws::String value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 218 of file PutMethodRequest.h.

◆ WithAuthorizationType() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizationType ( Aws::String &&  value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 226 of file PutMethodRequest.h.

◆ WithAuthorizationType() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizationType ( const char *  value)
inline

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Definition at line 234 of file PutMethodRequest.h.

◆ WithAuthorizerId() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizerId ( const Aws::String value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 277 of file PutMethodRequest.h.

◆ WithAuthorizerId() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizerId ( Aws::String &&  value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 284 of file PutMethodRequest.h.

◆ WithAuthorizerId() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithAuthorizerId ( const char *  value)
inline

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Definition at line 291 of file PutMethodRequest.h.

◆ WithHttpMethod() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithHttpMethod ( const Aws::String value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 159 of file PutMethodRequest.h.

◆ WithHttpMethod() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithHttpMethod ( Aws::String &&  value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 164 of file PutMethodRequest.h.

◆ WithHttpMethod() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithHttpMethod ( const char *  value)
inline

[Required] Specifies the method request's HTTP method type.

Definition at line 169 of file PutMethodRequest.h.

◆ WithOperationName() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithOperationName ( const Aws::String value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 355 of file PutMethodRequest.h.

◆ WithOperationName() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithOperationName ( Aws::String &&  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 362 of file PutMethodRequest.h.

◆ WithOperationName() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithOperationName ( const char *  value)
inline

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

Definition at line 369 of file PutMethodRequest.h.

◆ WithRequestModels() [1/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestModels ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 523 of file PutMethodRequest.h.

◆ WithRequestModels() [2/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestModels ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Definition at line 530 of file PutMethodRequest.h.

◆ WithRequestParameters() [1/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestParameters ( const Aws::Map< Aws::String, bool > &  value)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 435 of file PutMethodRequest.h.

◆ WithRequestParameters() [2/2]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestParameters ( Aws::Map< Aws::String, bool > &&  value)
inline

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Definition at line 448 of file PutMethodRequest.h.

◆ WithRequestValidatorId() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestValidatorId ( const Aws::String value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 616 of file PutMethodRequest.h.

◆ WithRequestValidatorId() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestValidatorId ( Aws::String &&  value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 622 of file PutMethodRequest.h.

◆ WithRequestValidatorId() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRequestValidatorId ( const char *  value)
inline

The identifier of a RequestValidator for validating the method request.

Definition at line 628 of file PutMethodRequest.h.

◆ WithResourceId() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithResourceId ( const Aws::String value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 116 of file PutMethodRequest.h.

◆ WithResourceId() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithResourceId ( Aws::String &&  value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 122 of file PutMethodRequest.h.

◆ WithResourceId() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithResourceId ( const char *  value)
inline

[Required] The Resource identifier for the new Method resource.

Definition at line 128 of file PutMethodRequest.h.

◆ WithRestApiId() [1/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 69 of file PutMethodRequest.h.

◆ WithRestApiId() [2/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 74 of file PutMethodRequest.h.

◆ WithRestApiId() [3/3]

PutMethodRequest& Aws::APIGateway::Model::PutMethodRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 79 of file PutMethodRequest.h.


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