Struct aws_sdk_apigateway::client::fluent_builders::ImportRestApi

pub struct ImportRestApi { /* private fields */ }

Fluent builder constructing a request to ImportRestApi.

A feature of the API Gateway control service for creating a new API from an external API definition file.

Implementations

impl ImportRestApi

pub async fn customize(
    self
) -> Result<CustomizableOperation<ImportRestApi, AwsResponseRetryClassifier>, SdkError<ImportRestApiError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ImportRestApiOutput, SdkError<ImportRestApiError>>

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

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

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, 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.

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

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

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.

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

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.

Trait Implementations

impl Clone for ImportRestApi

fn clone(&self) -> ImportRestApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImportRestApi

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

Formats the value using the given formatter.