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

#include <ImportRestApiRequest.h>

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

Public Member Functions

 ImportRestApiRequest ()
 
virtual const char * GetServiceRequestName () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
bool GetFailOnWarnings () const
 
bool FailOnWarningsHasBeenSet () const
 
void SetFailOnWarnings (bool value)
 
ImportRestApiRequestWithFailOnWarnings (bool value)
 
const Aws::Map< Aws::String, Aws::String > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
ImportRestApiRequestWithParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
ImportRestApiRequestWithParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
ImportRestApiRequestAddParameters (const Aws::String &key, const Aws::String &value)
 
ImportRestApiRequestAddParameters (Aws::String &&key, const Aws::String &value)
 
ImportRestApiRequestAddParameters (const Aws::String &key, Aws::String &&value)
 
ImportRestApiRequestAddParameters (Aws::String &&key, Aws::String &&value)
 
ImportRestApiRequestAddParameters (const char *key, Aws::String &&value)
 
ImportRestApiRequestAddParameters (Aws::String &&key, const char *value)
 
ImportRestApiRequestAddParameters (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) 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::AmazonStreamingWebServiceRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

A POST request to import an API to API Gateway using an input of an API definition file.

See Also:

AWS API Reference

Definition at line 31 of file ImportRestApiRequest.h.

Constructor & Destructor Documentation

◆ ImportRestApiRequest()

Aws::APIGateway::Model::ImportRestApiRequest::ImportRestApiRequest ( )

Member Function Documentation

◆ AddParameters() [1/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( const Aws::String key,
const Aws::String value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 226 of file ImportRestApiRequest.h.

◆ AddParameters() [2/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 248 of file ImportRestApiRequest.h.

◆ AddParameters() [3/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 270 of file ImportRestApiRequest.h.

◆ AddParameters() [4/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 292 of file ImportRestApiRequest.h.

◆ AddParameters() [5/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( const char *  key,
Aws::String &&  value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 314 of file ImportRestApiRequest.h.

◆ AddParameters() [6/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( Aws::String &&  key,
const char *  value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 336 of file ImportRestApiRequest.h.

◆ AddParameters() [7/7]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::AddParameters ( const char *  key,
const char *  value 
)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 358 of file ImportRestApiRequest.h.

◆ AddQueryStringParameters()

void Aws::APIGateway::Model::ImportRestApiRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FailOnWarningsHasBeenSet()

bool Aws::APIGateway::Model::ImportRestApiRequest::FailOnWarningsHasBeenSet ( ) const
inline

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 57 of file ImportRestApiRequest.h.

◆ GetFailOnWarnings()

bool Aws::APIGateway::Model::ImportRestApiRequest::GetFailOnWarnings ( ) const
inline

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 50 of file ImportRestApiRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::ImportRestApiRequest::GetParameters ( ) const
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 94 of file ImportRestApiRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 40 of file ImportRestApiRequest.h.

◆ ParametersHasBeenSet()

bool Aws::APIGateway::Model::ImportRestApiRequest::ParametersHasBeenSet ( ) const
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 116 of file ImportRestApiRequest.h.

◆ SetFailOnWarnings()

void Aws::APIGateway::Model::ImportRestApiRequest::SetFailOnWarnings ( bool  value)
inline

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 64 of file ImportRestApiRequest.h.

◆ SetParameters() [1/2]

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

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 138 of file ImportRestApiRequest.h.

◆ SetParameters() [2/2]

void Aws::APIGateway::Model::ImportRestApiRequest::SetParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 160 of file ImportRestApiRequest.h.

◆ WithFailOnWarnings()

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::WithFailOnWarnings ( bool  value)
inline

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

Definition at line 71 of file ImportRestApiRequest.h.

◆ WithParameters() [1/2]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::WithParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 182 of file ImportRestApiRequest.h.

◆ WithParameters() [2/2]

ImportRestApiRequest& Aws::APIGateway::Model::ImportRestApiRequest::WithParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters
ignore=documentation --body
'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway
import-rest-api –parameters endpointConfigurationTypes=REGIONAL –body
'file:///path/to/imported-api-body.json'

Definition at line 204 of file ImportRestApiRequest.h.


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