Struct aws_sdk_amplifybackend::client::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::retry::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
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
source§impl Client
impl Client
sourcepub fn clone_backend(&self) -> CloneBackend
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>
sourcepub fn create_backend(&self) -> CreateBackend
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>
sourcepub fn create_backend_api(&self) -> CreateBackendAPI
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>
sourcepub fn create_backend_auth(&self) -> CreateBackendAuth
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>
sourcepub fn create_backend_config(&self) -> CreateBackendConfig
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>
sourcepub fn create_backend_storage(&self) -> CreateBackendStorage
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>
sourcepub fn create_token(&self) -> CreateToken
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>
sourcepub fn delete_backend(&self) -> DeleteBackend
pub fn delete_backend(&self) -> DeleteBackend
Constructs a fluent builder for the DeleteBackend
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.
- On success, responds with
DeleteBackendOutput
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<DeleteBackendError>
sourcepub fn delete_backend_api(&self) -> DeleteBackendAPI
pub fn delete_backend_api(&self) -> DeleteBackendAPI
Constructs a fluent builder for the DeleteBackendAPI
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>)
:Defines the resource configuration for the data model in your Amplify project.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
DeleteBackendApiOutput
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<DeleteBackendAPIError>
sourcepub fn delete_backend_auth(&self) -> DeleteBackendAuth
pub fn delete_backend_auth(&self) -> DeleteBackendAuth
Constructs a fluent builder for the DeleteBackendAuth
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
DeleteBackendAuthOutput
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<DeleteBackendAuthError>
sourcepub fn delete_backend_storage(&self) -> DeleteBackendStorage
pub fn delete_backend_storage(&self) -> DeleteBackendStorage
Constructs a fluent builder for the DeleteBackendStorage
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of the storage resource.
service_name(ServiceName)
/set_service_name(Option<ServiceName>)
:The name of the storage service.
- On success, responds with
DeleteBackendStorageOutput
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<DeleteBackendStorageError>
sourcepub fn delete_token(&self) -> DeleteToken
pub fn delete_token(&self) -> DeleteToken
Constructs a fluent builder for the DeleteToken
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The app ID.
session_id(impl Into<String>)
/set_session_id(Option<String>)
:The session ID.
- On success, responds with
DeleteTokenOutput
with field(s):is_success(bool)
:Indicates whether the request succeeded or failed.
- On failure, responds with
SdkError<DeleteTokenError>
sourcepub fn generate_backend_api_models(&self) -> GenerateBackendAPIModels
pub fn generate_backend_api_models(&self) -> GenerateBackendAPIModels
Constructs a fluent builder for the GenerateBackendAPIModels
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
GenerateBackendApiModelsOutput
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<GenerateBackendAPIModelsError>
sourcepub fn get_backend(&self) -> GetBackend
pub fn get_backend(&self) -> GetBackend
Constructs a fluent builder for the GetBackend
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.
- On success, responds with
GetBackendOutput
with field(s):amplify_feature_flags(Option<String>)
:A stringified version of the cli.json file for your Amplify project.
amplify_meta_config(Option<String>)
:A stringified version of the current configs for your Amplify project.
app_id(Option<String>)
:The app ID.
app_name(Option<String>)
:The name of the app.
backend_environment_list(Option<Vec<String>>)
:A list of backend environments in an array.
backend_environment_name(Option<String>)
:The name of the backend environment.
error(Option<String>)
:If the request failed, this is the returned error.
- On failure, responds with
SdkError<GetBackendError>
sourcepub fn get_backend_api(&self) -> GetBackendAPI
pub fn get_backend_api(&self) -> GetBackendAPI
Constructs a fluent builder for the GetBackendAPI
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>)
:Defines the resource configuration for the data model in your Amplify project.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
GetBackendApiOutput
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.
resource_config(Option<BackendApiResourceConfig>)
:The resource configuration for this response object.
resource_name(Option<String>)
:The name of this resource.
- On failure, responds with
SdkError<GetBackendAPIError>
sourcepub fn get_backend_api_models(&self) -> GetBackendAPIModels
pub fn get_backend_api_models(&self) -> GetBackendAPIModels
Constructs a fluent builder for the GetBackendAPIModels
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
GetBackendApiModelsOutput
with field(s):models(Option<String>)
:Stringified JSON of the datastore model.
status(Option<Status>)
:The current status of the request.
model_introspection_schema(Option<String>)
:Stringified JSON of the model introspection schema for an existing backend API resource.
- On failure, responds with
SdkError<GetBackendAPIModelsError>
sourcepub fn get_backend_auth(&self) -> GetBackendAuth
pub fn get_backend_auth(&self) -> GetBackendAuth
Constructs a fluent builder for the GetBackendAuth
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
GetBackendAuthOutput
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.
resource_config(Option<CreateBackendAuthResourceConfig>)
:The resource configuration for authorization requests to the backend of your Amplify project.
resource_name(Option<String>)
:The name of this resource.
- On failure, responds with
SdkError<GetBackendAuthError>
sourcepub fn get_backend_job(&self) -> GetBackendJob
pub fn get_backend_job(&self) -> GetBackendJob
Constructs a fluent builder for the GetBackendJob
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.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID for the job.
- On success, responds with
GetBackendJobOutput
with field(s):app_id(Option<String>)
:The app ID.
backend_environment_name(Option<String>)
:The name of the backend environment.
create_time(Option<String>)
:The time when the job was created.
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.
update_time(Option<String>)
:The time when the job was last updated.
- On failure, responds with
SdkError<GetBackendJobError>
sourcepub fn get_backend_storage(&self) -> GetBackendStorage
pub fn get_backend_storage(&self) -> GetBackendStorage
Constructs a fluent builder for the GetBackendStorage
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_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of the storage resource.
- On success, responds with
GetBackendStorageOutput
with field(s):app_id(Option<String>)
:The app ID.
backend_environment_name(Option<String>)
:The name of the backend environment.
resource_config(Option<GetBackendStorageResourceConfig>)
:The resource configuration for the backend storage resource.
resource_name(Option<String>)
:The name of the storage resource.
- On failure, responds with
SdkError<GetBackendStorageError>
sourcepub fn get_token(&self) -> GetToken
pub fn get_token(&self) -> GetToken
Constructs a fluent builder for the GetToken
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The app ID.
session_id(impl Into<String>)
/set_session_id(Option<String>)
:The session ID.
- On success, responds with
GetTokenOutput
with field(s):app_id(Option<String>)
:The app ID.
challenge_code(Option<String>)
:The 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<GetTokenError>
sourcepub fn import_backend_auth(&self) -> ImportBackendAuth
pub fn import_backend_auth(&self) -> ImportBackendAuth
Constructs a fluent builder for the ImportBackendAuth
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.
identity_pool_id(impl Into<String>)
/set_identity_pool_id(Option<String>)
:The ID of the Amazon Cognito identity pool.
native_client_id(impl Into<String>)
/set_native_client_id(Option<String>)
:The ID of the Amazon Cognito native client.
user_pool_id(impl Into<String>)
/set_user_pool_id(Option<String>)
:The ID of the Amazon Cognito user pool.
web_client_id(impl Into<String>)
/set_web_client_id(Option<String>)
:The ID of the Amazon Cognito web client.
- On success, responds with
ImportBackendAuthOutput
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<ImportBackendAuthError>
sourcepub fn import_backend_storage(&self) -> ImportBackendStorage
pub fn import_backend_storage(&self) -> ImportBackendStorage
Constructs a fluent builder for the ImportBackendStorage
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.
bucket_name(impl Into<String>)
/set_bucket_name(Option<String>)
:The name of the S3 bucket.
service_name(ServiceName)
/set_service_name(Option<ServiceName>)
:The name of the storage service.
- On success, responds with
ImportBackendStorageOutput
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<ImportBackendStorageError>
sourcepub fn list_backend_jobs(&self) -> ListBackendJobs
pub fn list_backend_jobs(&self) -> ListBackendJobs
Constructs a fluent builder for the ListBackendJobs
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.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID for the job.
max_results(i32)
/set_max_results(i32)
:The maximum number of results that you want in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token for the next set of results.
operation(impl Into<String>)
/set_operation(Option<String>)
:Filters the list of response objects to include only those with the specified operation name.
status(impl Into<String>)
/set_status(Option<String>)
:Filters the list of response objects to include only those with the specified status.
- On success, responds with
ListBackendJobsOutput
with field(s):jobs(Option<Vec<BackendJobRespObj>>)
:An array of jobs and their properties.
next_token(Option<String>)
:The token for the next set of results.
- On failure, responds with
SdkError<ListBackendJobsError>
sourcepub fn list_s3_buckets(&self) -> ListS3Buckets
pub fn list_s3_buckets(&self) -> ListS3Buckets
Constructs a fluent builder for the ListS3Buckets
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:Reserved for future use.
- On success, responds with
ListS3BucketsOutput
with field(s):buckets(Option<Vec<S3BucketInfo>>)
:The list of S3 buckets.
next_token(Option<String>)
:Reserved for future use.
- On failure, responds with
SdkError<ListS3BucketsError>
sourcepub fn remove_all_backends(&self) -> RemoveAllBackends
pub fn remove_all_backends(&self) -> RemoveAllBackends
Constructs a fluent builder for the RemoveAllBackends
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The app ID.
clean_amplify_app(bool)
/set_clean_amplify_app(bool)
:Cleans up the Amplify Console app if this value is set to true.
- On success, responds with
RemoveAllBackendsOutput
with field(s):app_id(Option<String>)
:The app ID.
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<RemoveAllBackendsError>
sourcepub fn remove_backend_config(&self) -> RemoveBackendConfig
pub fn remove_backend_config(&self) -> RemoveBackendConfig
Constructs a fluent builder for the RemoveBackendConfig
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The app ID.
- On success, responds with
RemoveBackendConfigOutput
with field(s):error(Option<String>)
:If the request fails, this error is returned.
- On failure, responds with
SdkError<RemoveBackendConfigError>
sourcepub fn update_backend_api(&self) -> UpdateBackendAPI
pub fn update_backend_api(&self) -> UpdateBackendAPI
Constructs a fluent builder for the UpdateBackendAPI
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>)
:Defines the resource configuration for the data model in your Amplify project.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of this resource.
- On success, responds with
UpdateBackendApiOutput
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<UpdateBackendAPIError>
sourcepub fn update_backend_auth(&self) -> UpdateBackendAuth
pub fn update_backend_auth(&self) -> UpdateBackendAuth
Constructs a fluent builder for the UpdateBackendAuth
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(UpdateBackendAuthResourceConfig)
/set_resource_config(Option<UpdateBackendAuthResourceConfig>)
: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
UpdateBackendAuthOutput
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<UpdateBackendAuthError>
sourcepub fn update_backend_config(&self) -> UpdateBackendConfig
pub fn update_backend_config(&self) -> UpdateBackendConfig
Constructs a fluent builder for the UpdateBackendConfig
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The app ID.
login_auth_config(LoginAuthConfigReqObj)
/set_login_auth_config(Option<LoginAuthConfigReqObj>)
:Describes the Amazon Cognito configuration for Admin UI access.
- On success, responds with
UpdateBackendConfigOutput
with field(s):app_id(Option<String>)
:The app ID.
backend_manager_app_id(Option<String>)
:The app ID for the backend manager.
error(Option<String>)
:If the request fails, this error is returned.
login_auth_config(Option<LoginAuthConfigReqObj>)
:Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
- On failure, responds with
SdkError<UpdateBackendConfigError>
sourcepub fn update_backend_job(&self) -> UpdateBackendJob
pub fn update_backend_job(&self) -> UpdateBackendJob
Constructs a fluent builder for the UpdateBackendJob
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.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The ID for the job.
operation(impl Into<String>)
/set_operation(Option<String>)
:Filters the list of response objects to include only those with the specified operation name.
status(impl Into<String>)
/set_status(Option<String>)
:Filters the list of response objects to include only those with the specified status.
- On success, responds with
UpdateBackendJobOutput
with field(s):app_id(Option<String>)
:The app ID.
backend_environment_name(Option<String>)
:The name of the backend environment.
create_time(Option<String>)
:The time when the job was created.
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.
update_time(Option<String>)
:The time when the job was last updated.
- On failure, responds with
SdkError<UpdateBackendJobError>
sourcepub fn update_backend_storage(&self) -> UpdateBackendStorage
pub fn update_backend_storage(&self) -> UpdateBackendStorage
Constructs a fluent builder for the UpdateBackendStorage
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(UpdateBackendStorageResourceConfig)
/set_resource_config(Option<UpdateBackendStorageResourceConfig>)
:The resource configuration for updating backend storage.
resource_name(impl Into<String>)
/set_resource_name(Option<String>)
:The name of the storage resource.
- On success, responds with
UpdateBackendStorageOutput
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<UpdateBackendStorageError>
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
Panics
- This method will panic if the
conf
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
conf
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it.