aws_sdk_amplifybackend/client/
get_backend_api.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetBackendAPI`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`app_id(impl Into<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::app_id) / [`set_app_id(Option<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::set_app_id):<br>required: **true**<br><p>The app ID.</p><br>
7    ///   - [`backend_environment_name(impl Into<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::backend_environment_name) / [`set_backend_environment_name(Option<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::set_backend_environment_name):<br>required: **true**<br><p>The name of the backend environment.</p><br>
8    ///   - [`resource_config(BackendApiResourceConfig)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::resource_config) / [`set_resource_config(Option<BackendApiResourceConfig>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::set_resource_config):<br>required: **false**<br><p>Defines the resource configuration for the data model in your Amplify project.</p><br>
9    ///   - [`resource_name(impl Into<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::resource_name) / [`set_resource_name(Option<String>)`](crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::set_resource_name):<br>required: **true**<br><p>The name of this resource.</p><br>
10    /// - On success, responds with [`GetBackendApiOutput`](crate::operation::get_backend_api::GetBackendApiOutput) with field(s):
11    ///   - [`app_id(Option<String>)`](crate::operation::get_backend_api::GetBackendApiOutput::app_id): <p>The app ID.</p>
12    ///   - [`backend_environment_name(Option<String>)`](crate::operation::get_backend_api::GetBackendApiOutput::backend_environment_name): <p>The name of the backend environment.</p>
13    ///   - [`error(Option<String>)`](crate::operation::get_backend_api::GetBackendApiOutput::error): <p>If the request fails, this error is returned.</p>
14    ///   - [`resource_config(Option<BackendApiResourceConfig>)`](crate::operation::get_backend_api::GetBackendApiOutput::resource_config): <p>The resource configuration for this response object.</p>
15    ///   - [`resource_name(Option<String>)`](crate::operation::get_backend_api::GetBackendApiOutput::resource_name): <p>The name of this resource.</p>
16    /// - On failure, responds with [`SdkError<GetBackendAPIError>`](crate::operation::get_backend_api::GetBackendAPIError)
17    pub fn get_backend_api(&self) -> crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder {
18        crate::operation::get_backend_api::builders::GetBackendAPIFluentBuilder::new(self.handle.clone())
19    }
20}