Struct rusoto_apigateway::ImportRestApiRequest

pub struct ImportRestApiRequest {
    pub body: Bytes,
    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: Bytes

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML 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, 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'

Trait Implementations

impl PartialEq<ImportRestApiRequest> for ImportRestApiRequest

fn eq(&self, other: &ImportRestApiRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ImportRestApiRequest) -> bool

This method tests for !=.

impl Default for ImportRestApiRequest

fn default() -> ImportRestApiRequest

Returns the "default value" for a type.

impl Clone for ImportRestApiRequest

fn clone(&self) -> ImportRestApiRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImportRestApiRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for ImportRestApiRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.