Struct rusoto_apigateway::ImportRestApiRequest [−][src]
pub struct ImportRestApiRequest { pub body: Vec<u8>, pub fail_on_warnings: Option<bool>, pub parameters: Option<HashMap<String, String>>, }
A POST request to import an API to API Gateway using an input of an API definition file.
Fields
body: Vec<u8>
[Required] The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.
fail_on_warnings: Option<bool>
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
.
parameters: Option<HashMap<String, String>>
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
orendpointConfigurationTypes=REGIONAL
. 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
Trait Implementations
impl Default for ImportRestApiRequest
[src]
impl Default for ImportRestApiRequest
fn default() -> ImportRestApiRequest
[src]
fn default() -> ImportRestApiRequest
Returns the "default value" for a type. Read more
impl Debug for ImportRestApiRequest
[src]
impl Debug for ImportRestApiRequest
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for ImportRestApiRequest
[src]
impl Clone for ImportRestApiRequest
fn clone(&self) -> ImportRestApiRequest
[src]
fn clone(&self) -> ImportRestApiRequest
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl PartialEq for ImportRestApiRequest
[src]
impl PartialEq for ImportRestApiRequest
fn eq(&self, other: &ImportRestApiRequest) -> bool
[src]
fn eq(&self, other: &ImportRestApiRequest) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &ImportRestApiRequest) -> bool
[src]
fn ne(&self, other: &ImportRestApiRequest) -> bool
This method tests for !=
.
Auto Trait Implementations
impl Send for ImportRestApiRequest
impl Send for ImportRestApiRequest
impl Sync for ImportRestApiRequest
impl Sync for ImportRestApiRequest