Struct aws_sdk_apigateway::operation::import_rest_api::ImportRestApiInput

#[non_exhaustive]
pub struct ImportRestApiInput {
    pub fail_on_warnings: bool,
    pub parameters: Option<HashMap<String, String>>,
    pub body: Option<Blob>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fail_on_warnings: 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:

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

body: Option<Blob>

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 6MB.

Implementations

impl ImportRestApiInput

pub fn fail_on_warnings(&self) -> 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.

pub fn parameters(&self) -> 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:

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

pub fn body(&self) -> Option<&Blob>

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 6MB.

impl ImportRestApiInput

pub fn builder() -> ImportRestApiInputBuilder

Creates a new builder-style object to manufacture ImportRestApiInput.

Trait Implementations

impl Clone for ImportRestApiInput

fn clone(&self) -> ImportRestApiInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImportRestApiInput

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

Formats the value using the given formatter.

impl PartialEq<ImportRestApiInput> for ImportRestApiInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImportRestApiInput