Struct PutRestApiInput

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

A PUT request to update an existing API, with external API definitions specified as the request body.

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.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

mode: Option<PutMode>

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

fail_on_warnings: Option<bool>

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

parameters: Option<HashMap<String, String>>

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

body: Option<Blob>

The PUT 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 PutRestApiInput

pub fn rest_api_id(&self) -> Option<&str>

The string identifier of the associated RestApi.

pub fn mode(&self) -> Option<&PutMode>

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

pub fn fail_on_warnings(&self) -> Option<bool>

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

pub fn parameters(&self) -> Option<&HashMap<String, String>>

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

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

The PUT 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 PutRestApiInput

pub fn builder() -> PutRestApiInputBuilder

Creates a new builder-style object to manufacture PutRestApiInput.

Trait Implementations

impl Clone for PutRestApiInput

fn clone(&self) -> PutRestApiInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutRestApiInput

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

Formats the value using the given formatter.

impl PartialEq for PutRestApiInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PutRestApiInput