Struct aws_sdk_amplifybackend::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for AmplifyBackend

Client for invoking operations on AmplifyBackend. Each operation on AmplifyBackend is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_amplifybackend::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_amplifybackend::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_amplifybackend::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn clone_backend(&self) -> CloneBackend

Constructs a fluent builder for the CloneBackend operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- backend_environment_name(impl Into<String>) / set_backend_environment_name(Option<String>):
 The name of the backend environment.
- target_environment_name(impl Into<String>) / set_target_environment_name(Option<String>):
 The name of the destination backend environment to be created.
On success, responds with CloneBackendOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- error(Option<String>):
 If the request fails, this error is returned.
- job_id(Option<String>):
 The ID for the job.
- operation(Option<String>):
 The name of the operation.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CloneBackendError>

source

pub fn create_backend(&self) -> CreateBackend

Constructs a fluent builder for the CreateBackend operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- app_name(impl Into<String>) / set_app_name(Option<String>):
 The name of the app.
- backend_environment_name(impl Into<String>) / set_backend_environment_name(Option<String>):
 The name of the backend environment.
- resource_config(ResourceConfig) / set_resource_config(Option<ResourceConfig>):
 The resource configuration for creating a backend.
- resource_name(impl Into<String>) / set_resource_name(Option<String>):
 The name of the resource.
On success, responds with CreateBackendOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- error(Option<String>):
 If the request fails, this error is returned.
- job_id(Option<String>):
 The ID for the job.
- operation(Option<String>):
 The name of the operation.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CreateBackendError>

source

pub fn create_backend_api(&self) -> CreateBackendAPI

Constructs a fluent builder for the CreateBackendAPI operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- backend_environment_name(impl Into<String>) / set_backend_environment_name(Option<String>):
 The name of the backend environment.
- resource_config(BackendApiResourceConfig) / set_resource_config(Option<BackendApiResourceConfig>):
 The resource configuration for this request.
- resource_name(impl Into<String>) / set_resource_name(Option<String>):
 The name of this resource.
On success, responds with CreateBackendApiOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- error(Option<String>):
 If the request fails, this error is returned.
- job_id(Option<String>):
 The ID for the job.
- operation(Option<String>):
 The name of the operation.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CreateBackendAPIError>

source

pub fn create_backend_auth(&self) -> CreateBackendAuth

Constructs a fluent builder for the CreateBackendAuth operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- backend_environment_name(impl Into<String>) / set_backend_environment_name(Option<String>):
 The name of the backend environment.
- resource_config(CreateBackendAuthResourceConfig) / set_resource_config(Option<CreateBackendAuthResourceConfig>):
 The resource configuration for this request object.
- resource_name(impl Into<String>) / set_resource_name(Option<String>):
 The name of this resource.
On success, responds with CreateBackendAuthOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- error(Option<String>):
 If the request fails, this error is returned.
- job_id(Option<String>):
 The ID for the job.
- operation(Option<String>):
 The name of the operation.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CreateBackendAuthError>

source

pub fn create_backend_config(&self) -> CreateBackendConfig

Constructs a fluent builder for the CreateBackendConfig operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- backend_manager_app_id(impl Into<String>) / set_backend_manager_app_id(Option<String>):
 The app ID for the backend manager.
On success, responds with CreateBackendConfigOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- job_id(Option<String>):
 The ID for the job.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CreateBackendConfigError>

source

pub fn create_backend_storage(&self) -> CreateBackendStorage

Constructs a fluent builder for the CreateBackendStorage operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
- backend_environment_name(impl Into<String>) / set_backend_environment_name(Option<String>):
 The name of the backend environment.
- resource_config(CreateBackendStorageResourceConfig) / set_resource_config(Option<CreateBackendStorageResourceConfig>):
 The resource configuration for creating backend storage.
- resource_name(impl Into<String>) / set_resource_name(Option<String>):
 The name of the storage resource.
On success, responds with CreateBackendStorageOutput with field(s):
- app_id(Option<String>):
 The app ID.
- backend_environment_name(Option<String>):
 The name of the backend environment.
- job_id(Option<String>):
 The ID for the job.
- status(Option<String>):
 The current status of the request.
On failure, responds with SdkError<CreateBackendStorageError>

source

pub fn create_token(&self) -> CreateToken

Constructs a fluent builder for the CreateToken operation.

The fluent builder is configurable:
- app_id(impl Into<String>) / set_app_id(Option<String>):
 The app ID.
On success, responds with CreateTokenOutput with field(s):
- app_id(Option<String>):
 The app ID.
- challenge_code(Option<String>):
 One-time challenge code for authenticating into the Amplify Admin UI.
- session_id(Option<String>):
 A unique ID provided when creating a new challenge token.
- ttl(Option<String>):
 The expiry time for the one-time generated token code.
On failure, responds with SdkError<CreateTokenError>