Struct aws_sdk_apigateway::operation::put_rest_api::builders::PutRestApiFluentBuilder

pub struct PutRestApiFluentBuilder { /* private fields */ }

Fluent builder constructing a request to PutRestApi.

A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Implementations

impl PutRestApiFluentBuilder

pub fn as_input(&self) -> &PutRestApiInputBuilder

Access the PutRestApi as a reference.

pub async fn send( self ) -> Result<PutRestApiOutput, SdkError<PutRestApiError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<PutRestApiOutput, PutRestApiError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn rest_api_id(self, input: impl Into<String>) -> Self

The string identifier of the associated RestApi.

pub fn set_rest_api_id(self, input: Option<String>) -> Self

The string identifier of the associated RestApi.

pub fn get_rest_api_id(&self) -> &Option<String>

The string identifier of the associated RestApi.

pub fn mode(self, input: PutMode) -> Self

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

pub fn set_mode(self, input: Option<PutMode>) -> Self

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

pub fn get_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, input: bool) -> Self

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 set_fail_on_warnings(self, input: Option<bool>) -> Self

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 get_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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

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 set_parameters(self, input: Option<HashMap<String, String>>) -> Self

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 get_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, input: Blob) -> Self

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.

pub fn set_body(self, input: Option<Blob>) -> Self

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.

pub fn get_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.

Trait Implementations

impl Clone for PutRestApiFluentBuilder

fn clone(&self) -> PutRestApiFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutRestApiFluentBuilder

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

Formats the value using the given formatter.