#[non_exhaustive]pub struct UpdateRestApiOutput {Show 14 fields
pub id: Option<String>,
pub name: Option<String>,
pub description: Option<String>,
pub created_date: Option<DateTime>,
pub version: Option<String>,
pub warnings: Option<Vec<String>>,
pub binary_media_types: Option<Vec<String>>,
pub minimum_compression_size: Option<i32>,
pub api_key_source: Option<ApiKeySourceType>,
pub endpoint_configuration: Option<EndpointConfiguration>,
pub policy: Option<String>,
pub tags: Option<HashMap<String, String>>,
pub disable_execute_api_endpoint: bool,
pub root_resource_id: Option<String>,
/* private fields */
}
Expand description
Represents a REST API.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<String>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
name: Option<String>
The API's name.
description: Option<String>
The API's description.
created_date: Option<DateTime>
The timestamp when the API was created.
version: Option<String>
A version identifier for the API.
warnings: Option<Vec<String>>
The warning messages reported when failonwarnings
is turned on during API import.
binary_media_types: Option<Vec<String>>
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
minimum_compression_size: Option<i32>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
api_key_source: Option<ApiKeySourceType>
The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
endpoint_configuration: Option<EndpointConfiguration>
The endpoint configuration of this RestApi showing the endpoint types of the API.
policy: Option<String>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
The collection of tags. Each tag element is associated with a given resource.
disable_execute_api_endpoint: bool
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
root_resource_id: Option<String>
The API's root resource ID.
Implementations§
source§impl UpdateRestApiOutput
impl UpdateRestApiOutput
sourcepub fn id(&self) -> Option<&str>
pub fn id(&self) -> Option<&str>
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The API's description.
sourcepub fn created_date(&self) -> Option<&DateTime>
pub fn created_date(&self) -> Option<&DateTime>
The timestamp when the API was created.
sourcepub fn warnings(&self) -> &[String]
pub fn warnings(&self) -> &[String]
The warning messages reported when failonwarnings
is turned on during API import.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .warnings.is_none()
.
sourcepub fn binary_media_types(&self) -> &[String]
pub fn binary_media_types(&self) -> &[String]
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .binary_media_types.is_none()
.
sourcepub fn minimum_compression_size(&self) -> Option<i32>
pub fn minimum_compression_size(&self) -> Option<i32>
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
sourcepub fn api_key_source(&self) -> Option<&ApiKeySourceType>
pub fn api_key_source(&self) -> Option<&ApiKeySourceType>
The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER
to read the API key from the X-API-Key
header of a request. AUTHORIZER
to read the API key from the UsageIdentifierKey
from a custom authorizer.
sourcepub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>
pub fn endpoint_configuration(&self) -> Option<&EndpointConfiguration>
The endpoint configuration of this RestApi showing the endpoint types of the API.
sourcepub fn policy(&self) -> Option<&str>
pub fn policy(&self) -> Option<&str>
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
The collection of tags. Each tag element is associated with a given resource.
sourcepub fn disable_execute_api_endpoint(&self) -> bool
pub fn disable_execute_api_endpoint(&self) -> bool
Specifies whether clients can invoke your API by using the default execute-api
endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
sourcepub fn root_resource_id(&self) -> Option<&str>
pub fn root_resource_id(&self) -> Option<&str>
The API's root resource ID.
source§impl UpdateRestApiOutput
impl UpdateRestApiOutput
sourcepub fn builder() -> UpdateRestApiOutputBuilder
pub fn builder() -> UpdateRestApiOutputBuilder
Creates a new builder-style object to manufacture UpdateRestApiOutput
.
Trait Implementations§
source§impl Clone for UpdateRestApiOutput
impl Clone for UpdateRestApiOutput
source§fn clone(&self) -> UpdateRestApiOutput
fn clone(&self) -> UpdateRestApiOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UpdateRestApiOutput
impl Debug for UpdateRestApiOutput
source§impl PartialEq for UpdateRestApiOutput
impl PartialEq for UpdateRestApiOutput
source§fn eq(&self, other: &UpdateRestApiOutput) -> bool
fn eq(&self, other: &UpdateRestApiOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for UpdateRestApiOutput
impl RequestId for UpdateRestApiOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for UpdateRestApiOutput
Auto Trait Implementations§
impl Freeze for UpdateRestApiOutput
impl RefUnwindSafe for UpdateRestApiOutput
impl Send for UpdateRestApiOutput
impl Sync for UpdateRestApiOutput
impl Unpin for UpdateRestApiOutput
impl UnwindSafe for UpdateRestApiOutput
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more