Struct aws_sdk_amplifyuibuilder::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Amplify UI Builder
Client for invoking operations on AWS Amplify UI Builder. Each operation on AWS Amplify UI Builder is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_amplifyuibuilder::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_amplifyuibuilder::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the ExchangeCodeForToken
operation has
a Client::exchange_code_for_token
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.exchange_code_for_token()
.provider("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_component(&self) -> CreateComponentFluentBuilder
pub fn create_component(&self) -> CreateComponentFluentBuilder
Constructs a fluent builder for the CreateComponent
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app to associate with the component.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
component_to_create(CreateComponentData)
/set_component_to_create(Option<CreateComponentData>)
:
required: trueRepresents the configuration of the component to create.
- On success, responds with
CreateComponentOutput
with field(s):entity(Option<Component>)
:Describes the configuration of the new component.
- On failure, responds with
SdkError<CreateComponentError>
source§impl Client
impl Client
sourcepub fn create_form(&self) -> CreateFormFluentBuilder
pub fn create_form(&self) -> CreateFormFluentBuilder
Constructs a fluent builder for the CreateForm
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app to associate with the form.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
form_to_create(CreateFormData)
/set_form_to_create(Option<CreateFormData>)
:
required: trueRepresents the configuration of the form to create.
- On success, responds with
CreateFormOutput
with field(s):entity(Option<Form>)
:Describes the configuration of the new form.
- On failure, responds with
SdkError<CreateFormError>
source§impl Client
impl Client
sourcepub fn create_theme(&self) -> CreateThemeFluentBuilder
pub fn create_theme(&self) -> CreateThemeFluentBuilder
Constructs a fluent builder for the CreateTheme
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app associated with the theme.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
theme_to_create(CreateThemeData)
/set_theme_to_create(Option<CreateThemeData>)
:
required: trueRepresents the configuration of the theme to create.
- On success, responds with
CreateThemeOutput
with field(s):entity(Option<Theme>)
:Describes the configuration of the new theme.
- On failure, responds with
SdkError<CreateThemeError>
source§impl Client
impl Client
sourcepub fn delete_component(&self) -> DeleteComponentFluentBuilder
pub fn delete_component(&self) -> DeleteComponentFluentBuilder
Constructs a fluent builder for the DeleteComponent
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app associated with the component to delete.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the component to delete.
- On success, responds with
DeleteComponentOutput
- On failure, responds with
SdkError<DeleteComponentError>
source§impl Client
impl Client
sourcepub fn delete_form(&self) -> DeleteFormFluentBuilder
pub fn delete_form(&self) -> DeleteFormFluentBuilder
Constructs a fluent builder for the DeleteForm
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app associated with the form to delete.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the form to delete.
- On success, responds with
DeleteFormOutput
- On failure, responds with
SdkError<DeleteFormError>
source§impl Client
impl Client
sourcepub fn delete_theme(&self) -> DeleteThemeFluentBuilder
pub fn delete_theme(&self) -> DeleteThemeFluentBuilder
Constructs a fluent builder for the DeleteTheme
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app associated with the theme to delete.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the theme to delete.
- On success, responds with
DeleteThemeOutput
- On failure, responds with
SdkError<DeleteThemeError>
source§impl Client
impl Client
sourcepub fn exchange_code_for_token(&self) -> ExchangeCodeForTokenFluentBuilder
pub fn exchange_code_for_token(&self) -> ExchangeCodeForTokenFluentBuilder
Constructs a fluent builder for the ExchangeCodeForToken
operation.
- The fluent builder is configurable:
provider(TokenProviders)
/set_provider(Option<TokenProviders>)
:
required: trueThe third-party provider for the token. The only valid value is
figma
.request(ExchangeCodeForTokenRequestBody)
/set_request(Option<ExchangeCodeForTokenRequestBody>)
:
required: trueDescribes the configuration of the request.
- On success, responds with
ExchangeCodeForTokenOutput
with field(s):access_token(String)
:The access token.
expires_in(i32)
:The date and time when the new access token expires.
refresh_token(String)
:The token to use to refresh a previously issued access token that might have expired.
- On failure, responds with
SdkError<ExchangeCodeForTokenError>
source§impl Client
impl Client
sourcepub fn export_components(&self) -> ExportComponentsFluentBuilder
pub fn export_components(&self) -> ExportComponentsFluentBuilder
Constructs a fluent builder for the ExportComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app to export components to.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
- On success, responds with
ExportComponentsOutput
with field(s):entities(Vec::<Component>)
:Represents the configuration of the exported components.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ExportComponentsError>
source§impl Client
impl Client
sourcepub fn export_forms(&self) -> ExportFormsFluentBuilder
pub fn export_forms(&self) -> ExportFormsFluentBuilder
Constructs a fluent builder for the ExportForms
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app to export forms to.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
- On success, responds with
ExportFormsOutput
with field(s):entities(Vec::<Form>)
:Represents the configuration of the exported forms.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ExportFormsError>
source§impl Client
impl Client
sourcepub fn export_themes(&self) -> ExportThemesFluentBuilder
pub fn export_themes(&self) -> ExportThemesFluentBuilder
Constructs a fluent builder for the ExportThemes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app to export the themes to.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
- On success, responds with
ExportThemesOutput
with field(s):entities(Vec::<Theme>)
:Represents the configuration of the exported themes.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ExportThemesError>
source§impl Client
impl Client
sourcepub fn get_codegen_job(&self) -> GetCodegenJobFluentBuilder
pub fn get_codegen_job(&self) -> GetCodegenJobFluentBuilder
Constructs a fluent builder for the GetCodegenJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app associated with the code generation job.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app associated with the code generation job.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the code generation job.
- On success, responds with
GetCodegenJobOutput
with field(s):job(Option<CodegenJob>)
:The configuration settings for the code generation job.
- On failure, responds with
SdkError<GetCodegenJobError>
source§impl Client
impl Client
sourcepub fn get_component(&self) -> GetComponentFluentBuilder
pub fn get_component(&self) -> GetComponentFluentBuilder
Constructs a fluent builder for the GetComponent
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the component.
- On success, responds with
GetComponentOutput
with field(s):component(Option<Component>)
:Represents the configuration settings for the component.
- On failure, responds with
SdkError<GetComponentError>
source§impl Client
impl Client
sourcepub fn get_form(&self) -> GetFormFluentBuilder
pub fn get_form(&self) -> GetFormFluentBuilder
Constructs a fluent builder for the GetForm
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID of the form.
- On success, responds with
GetFormOutput
with field(s):form(Option<Form>)
:Represents the configuration settings for the form.
- On failure, responds with
SdkError<GetFormError>
source§impl Client
impl Client
sourcepub fn get_metadata(&self) -> GetMetadataFluentBuilder
pub fn get_metadata(&self) -> GetMetadataFluentBuilder
Constructs a fluent builder for the GetMetadata
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
- On success, responds with
GetMetadataOutput
with field(s):features(HashMap::<String, String>)
:Represents the configuration settings for the features metadata.
- On failure, responds with
SdkError<GetMetadataError>
source§impl Client
impl Client
sourcepub fn get_theme(&self) -> GetThemeFluentBuilder
pub fn get_theme(&self) -> GetThemeFluentBuilder
Constructs a fluent builder for the GetTheme
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID of the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID for the theme.
- On success, responds with
GetThemeOutput
with field(s):theme(Option<Theme>)
:Represents the configuration settings for the theme.
- On failure, responds with
SdkError<GetThemeError>
source§impl Client
impl Client
sourcepub fn list_codegen_jobs(&self) -> ListCodegenJobsFluentBuilder
pub fn list_codegen_jobs(&self) -> ListCodegenJobsFluentBuilder
Constructs a fluent builder for the ListCodegenJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of jobs to retrieve.
- On success, responds with
ListCodegenJobsOutput
with field(s):entities(Vec::<CodegenJobSummary>)
:The list of code generation jobs for the Amplify app.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListCodegenJobsError>
source§impl Client
impl Client
sourcepub fn list_components(&self) -> ListComponentsFluentBuilder
pub fn list_components(&self) -> ListComponentsFluentBuilder
Constructs a fluent builder for the ListComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of components to retrieve.
- On success, responds with
ListComponentsOutput
with field(s):entities(Vec::<ComponentSummary>)
:The list of components for the Amplify app.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListComponentsError>
source§impl Client
impl Client
sourcepub fn list_forms(&self) -> ListFormsFluentBuilder
pub fn list_forms(&self) -> ListFormsFluentBuilder
Constructs a fluent builder for the ListForms
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of forms to retrieve.
- On success, responds with
ListFormsOutput
with field(s):entities(Vec::<FormSummary>)
:The list of forms for the Amplify app.
next_token(Option<String>)
:The pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListFormsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) to use to list tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(HashMap::<String, String>)
:A list of tag key value pairs for a specified Amazon Resource Name (ARN).
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_themes(&self) -> ListThemesFluentBuilder
pub fn list_themes(&self) -> ListThemesFluentBuilder
Constructs a fluent builder for the ListThemes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to request the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of theme results to return in the response.
- On success, responds with
ListThemesOutput
with field(s):entities(Vec::<ThemeSummary>)
:The list of themes for the Amplify app.
next_token(Option<String>)
:The pagination token that’s returned if more results are available.
- On failure, responds with
SdkError<ListThemesError>
source§impl Client
impl Client
sourcepub fn put_metadata_flag(&self) -> PutMetadataFlagFluentBuilder
pub fn put_metadata_flag(&self) -> PutMetadataFlagFluentBuilder
Constructs a fluent builder for the PutMetadataFlag
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
feature_name(impl Into<String>)
/set_feature_name(Option<String>)
:
required: trueThe name of the feature associated with the metadata.
body(PutMetadataFlagBody)
/set_body(Option<PutMetadataFlagBody>)
:
required: trueThe metadata information to store.
- On success, responds with
PutMetadataFlagOutput
- On failure, responds with
SdkError<PutMetadataFlagError>
source§impl Client
impl Client
sourcepub fn refresh_token(&self) -> RefreshTokenFluentBuilder
pub fn refresh_token(&self) -> RefreshTokenFluentBuilder
Constructs a fluent builder for the RefreshToken
operation.
- The fluent builder is configurable:
provider(TokenProviders)
/set_provider(Option<TokenProviders>)
:
required: trueThe third-party provider for the token. The only valid value is
figma
.refresh_token_body(RefreshTokenRequestBody)
/set_refresh_token_body(Option<RefreshTokenRequestBody>)
:
required: trueInformation about the refresh token request.
- On success, responds with
RefreshTokenOutput
with field(s):access_token(String)
:The access token.
expires_in(i32)
:The date and time when the new access token expires.
- On failure, responds with
SdkError<RefreshTokenError>
source§impl Client
impl Client
sourcepub fn start_codegen_job(&self) -> StartCodegenJobFluentBuilder
pub fn start_codegen_job(&self) -> StartCodegenJobFluentBuilder
Constructs a fluent builder for the StartCodegenJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is a part of the Amplify app.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe idempotency token used to ensure that the code generation job request completes only once.
codegen_job_to_create(StartCodegenJobData)
/set_codegen_job_to_create(Option<StartCodegenJobData>)
:
required: trueThe code generation job resource configuration.
- On success, responds with
StartCodegenJobOutput
with field(s):entity(Option<CodegenJob>)
:The code generation job for a UI component that is associated with an Amplify app.
- On failure, responds with
SdkError<StartCodegenJobError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) to use to tag a resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA list of tag key value pairs for a specified Amazon Resource Name (ARN).
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) to use to untag a resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys to use to untag a resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_component(&self) -> UpdateComponentFluentBuilder
pub fn update_component(&self) -> UpdateComponentFluentBuilder
Constructs a fluent builder for the UpdateComponent
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID for the component.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
updated_component(UpdateComponentData)
/set_updated_component(Option<UpdateComponentData>)
:
required: trueThe configuration of the updated component.
- On success, responds with
UpdateComponentOutput
with field(s):entity(Option<Component>)
:Describes the configuration of the updated component.
- On failure, responds with
SdkError<UpdateComponentError>
source§impl Client
impl Client
sourcepub fn update_form(&self) -> UpdateFormFluentBuilder
pub fn update_form(&self) -> UpdateFormFluentBuilder
Constructs a fluent builder for the UpdateForm
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID for the form.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
updated_form(UpdateFormData)
/set_updated_form(Option<UpdateFormData>)
:
required: trueThe request accepts the following data in JSON format.
- On success, responds with
UpdateFormOutput
with field(s):entity(Option<Form>)
:Describes the configuration of the updated form.
- On failure, responds with
SdkError<UpdateFormError>
source§impl Client
impl Client
sourcepub fn update_theme(&self) -> UpdateThemeFluentBuilder
pub fn update_theme(&self) -> UpdateThemeFluentBuilder
Constructs a fluent builder for the UpdateTheme
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:
required: trueThe unique ID for the Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:
required: trueThe name of the backend environment that is part of the Amplify app.
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe unique ID for the theme.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseThe unique client token.
updated_theme(UpdateThemeData)
/set_updated_theme(Option<UpdateThemeData>)
:
required: trueThe configuration of the updated theme.
- On success, responds with
UpdateThemeOutput
with field(s):entity(Option<Theme>)
:Describes the configuration of the updated theme.
- On failure, responds with
SdkError<UpdateThemeError>
source§impl Client
impl Client
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 in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
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. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more