Struct rusoto_apigateway::ImportRestApiRequest
source · [−]pub struct ImportRestApiRequest {
pub body: Bytes,
pub fail_on_warnings: Option<bool>,
pub parameters: Option<HashMap<String, String>>,
}
Expand description
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 6MB.
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
sourceimpl Clone for ImportRestApiRequest
impl Clone for ImportRestApiRequest
sourcefn clone(&self) -> ImportRestApiRequest
fn clone(&self) -> ImportRestApiRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ImportRestApiRequest
impl Debug for ImportRestApiRequest
sourceimpl Default for ImportRestApiRequest
impl Default for ImportRestApiRequest
sourcefn default() -> ImportRestApiRequest
fn default() -> ImportRestApiRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<ImportRestApiRequest> for ImportRestApiRequest
impl PartialEq<ImportRestApiRequest> for ImportRestApiRequest
sourcefn eq(&self, other: &ImportRestApiRequest) -> bool
fn eq(&self, other: &ImportRestApiRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &ImportRestApiRequest) -> bool
fn ne(&self, other: &ImportRestApiRequest) -> bool
This method tests for !=
.
sourceimpl Serialize for ImportRestApiRequest
impl Serialize for ImportRestApiRequest
impl StructuralPartialEq for ImportRestApiRequest
Auto Trait Implementations
impl RefUnwindSafe for ImportRestApiRequest
impl Send for ImportRestApiRequest
impl Sync for ImportRestApiRequest
impl Unpin for ImportRestApiRequest
impl UnwindSafe for ImportRestApiRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more