Struct aws_sdk_amplify::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }
Expand description
Client for AWS Amplify
Client for invoking operations on AWS Amplify. Each operation on AWS Amplify 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_amplify::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_amplify::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_amplify::Client::from_conf(config);
Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the CreateApp
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name for an Amplify app.
description(impl Into<String>)
/set_description(Option<String>)
:The description for an Amplify app.
repository(impl Into<String>)
/set_repository(Option<String>)
:The repository for an Amplify app.
platform(Platform)
/set_platform(Option<Platform>)
:The platform or framework for an Amplify app.
iam_service_role_arn(impl Into<String>)
/set_iam_service_role_arn(Option<String>)
:The AWS Identity and Access Management (IAM) service role for an Amplify app.
oauth_token(impl Into<String>)
/set_oauth_token(Option<String>)
:The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
access_token(impl Into<String>)
/set_access_token(Option<String>)
:The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
environment_variables(HashMap<String, String>)
/set_environment_variables(Option<HashMap<String, String>>)
:The environment variables map for an Amplify app.
enable_branch_auto_build(bool)
/set_enable_branch_auto_build(Option<bool>)
:Enables the auto building of branches for an Amplify app.
enable_branch_auto_deletion(bool)
/set_enable_branch_auto_deletion(Option<bool>)
:Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
enable_basic_auth(bool)
/set_enable_basic_auth(Option<bool>)
:Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
basic_auth_credentials(impl Into<String>)
/set_basic_auth_credentials(Option<String>)
:The credentials for basic authorization for an Amplify app.
custom_rules(Vec<CustomRule>)
/set_custom_rules(Option<Vec<CustomRule>>)
:The custom rewrite and redirect rules for an Amplify app.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tag for an Amplify app.
build_spec(impl Into<String>)
/set_build_spec(Option<String>)
:The build specification (build spec) for an Amplify app.
custom_headers(impl Into<String>)
/set_custom_headers(Option<String>)
:The custom HTTP headers for an Amplify app.
enable_auto_branch_creation(bool)
/set_enable_auto_branch_creation(Option<bool>)
:Enables automated branch creation for an Amplify app.
auto_branch_creation_patterns(Vec<String>)
/set_auto_branch_creation_patterns(Option<Vec<String>>)
:The automated branch creation glob patterns for an Amplify app.
auto_branch_creation_config(AutoBranchCreationConfig)
/set_auto_branch_creation_config(Option<AutoBranchCreationConfig>)
:The automated branch creation configuration for an Amplify app.
- On success, responds with
CreateAppOutput
with field(s):app(Option<App>)
:Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
- On failure, responds with
SdkError<CreateAppError>
Constructs a fluent builder for the CreateBackendEnvironment
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:The name for the backend environment.
stack_name(impl Into<String>)
/set_stack_name(Option<String>)
:The AWS CloudFormation stack name of a backend environment.
deployment_artifacts(impl Into<String>)
/set_deployment_artifacts(Option<String>)
:The name of deployment artifacts.
- On success, responds with
CreateBackendEnvironmentOutput
with field(s):backend_environment(Option<BackendEnvironment>)
:Describes the backend environment for an Amplify app.
- On failure, responds with
SdkError<CreateBackendEnvironmentError>
Constructs a fluent builder for the CreateBranch
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch.
description(impl Into<String>)
/set_description(Option<String>)
:The description for the branch.
stage(Stage)
/set_stage(Option<Stage>)
:Describes the current stage for the branch.
framework(impl Into<String>)
/set_framework(Option<String>)
:The framework for the branch.
enable_notification(bool)
/set_enable_notification(Option<bool>)
:Enables notifications for the branch.
enable_auto_build(bool)
/set_enable_auto_build(Option<bool>)
:Enables auto building for the branch.
environment_variables(HashMap<String, String>)
/set_environment_variables(Option<HashMap<String, String>>)
:The environment variables for the branch.
basic_auth_credentials(impl Into<String>)
/set_basic_auth_credentials(Option<String>)
:The basic authorization credentials for the branch.
enable_basic_auth(bool)
/set_enable_basic_auth(Option<bool>)
:Enables basic authorization for the branch.
enable_performance_mode(bool)
/set_enable_performance_mode(Option<bool>)
:Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tag for the branch.
build_spec(impl Into<String>)
/set_build_spec(Option<String>)
:The build specification (build spec) for the branch.
ttl(impl Into<String>)
/set_ttl(Option<String>)
:The content Time To Live (TTL) for the website in seconds.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:The display name for a branch. This is used as the default domain prefix.
enable_pull_request_preview(bool)
/set_enable_pull_request_preview(Option<bool>)
:Enables pull request previews for this branch.
pull_request_environment_name(impl Into<String>)
/set_pull_request_environment_name(Option<String>)
:The Amplify environment name for the pull request.
backend_environment_arn(impl Into<String>)
/set_backend_environment_arn(Option<String>)
:The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- On success, responds with
CreateBranchOutput
with field(s):branch(Option<Branch>)
:Describes the branch for an Amplify app, which maps to a third-party repository branch.
- On failure, responds with
SdkError<CreateBranchError>
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch, for the job.
file_map(HashMap<String, String>)
/set_file_map(Option<HashMap<String, String>>)
:An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.
- On success, responds with
CreateDeploymentOutput
with field(s):job_id(Option<String>)
:The job ID for this deployment. will supply to start deployment api.
file_upload_urls(Option<HashMap<String, String>>)
:When the
fileMap
argument is provided in the request,fileUploadUrls
will contain a map of file names to upload URLs.zip_upload_url(Option<String>)
:When the
fileMap
argument is not provided in the request, thiszipUploadUrl
is returned.
- On failure, responds with
SdkError<CreateDeploymentError>
Constructs a fluent builder for the CreateDomainAssociation
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The domain name for the domain association.
enable_auto_sub_domain(bool)
/set_enable_auto_sub_domain(Option<bool>)
:Enables the automated creation of subdomains for branches.
sub_domain_settings(Vec<SubDomainSetting>)
/set_sub_domain_settings(Option<Vec<SubDomainSetting>>)
:The setting for the subdomain.
auto_sub_domain_creation_patterns(Vec<String>)
/set_auto_sub_domain_creation_patterns(Option<Vec<String>>)
:Sets the branch patterns for automatic subdomain creation.
auto_sub_domain_iam_role(impl Into<String>)
/set_auto_sub_domain_iam_role(Option<String>)
:The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
- On success, responds with
CreateDomainAssociationOutput
with field(s):domain_association(Option<DomainAssociation>)
:Describes the structure of a domain association, which associates a custom domain with an Amplify app.
- On failure, responds with
SdkError<CreateDomainAssociationError>
Constructs a fluent builder for the CreateWebhook
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for a branch that is part of an Amplify app.
description(impl Into<String>)
/set_description(Option<String>)
:The description for a webhook.
- On success, responds with
CreateWebhookOutput
with field(s):webhook(Option<Webhook>)
:Describes a webhook that connects repository events to an Amplify app.
- On failure, responds with
SdkError<CreateWebhookError>
Constructs a fluent builder for the DeleteApp
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
- On success, responds with
DeleteAppOutput
with field(s):app(Option<App>)
:Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
- On failure, responds with
SdkError<DeleteAppError>
Constructs a fluent builder for the DeleteBackendEnvironment
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID of an Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:The name of a backend environment of an Amplify app.
- On success, responds with
DeleteBackendEnvironmentOutput
with field(s):backend_environment(Option<BackendEnvironment>)
:Describes the backend environment for an Amplify app.
- On failure, responds with
SdkError<DeleteBackendEnvironmentError>
Constructs a fluent builder for the DeleteBranch
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch.
- On success, responds with
DeleteBranchOutput
with field(s):branch(Option<Branch>)
:The branch for an Amplify app, which maps to a third-party repository branch.
- On failure, responds with
SdkError<DeleteBranchError>
Constructs a fluent builder for the DeleteDomainAssociation
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique id for an Amplify app.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the domain.
- On success, responds with
DeleteDomainAssociationOutput
with field(s):domain_association(Option<DomainAssociation>)
:Describes a domain association that associates a custom domain with an Amplify app.
- On failure, responds with
SdkError<DeleteDomainAssociationError>
Constructs a fluent builder for the DeleteJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch, for the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique ID for the job.
- On success, responds with
DeleteJobOutput
with field(s):job_summary(Option<JobSummary>)
:Describes the summary for an execution job for an Amplify app.
- On failure, responds with
SdkError<DeleteJobError>
Constructs a fluent builder for the DeleteWebhook
operation.
- The fluent builder is configurable:
webhook_id(impl Into<String>)
/set_webhook_id(Option<String>)
:The unique ID for a webhook.
- On success, responds with
DeleteWebhookOutput
with field(s):webhook(Option<Webhook>)
:Describes a webhook that connects repository events to an Amplify app.
- On failure, responds with
SdkError<DeleteWebhookError>
Constructs a fluent builder for the GenerateAccessLogs
operation.
- The fluent builder is configurable:
start_time(DateTime)
/set_start_time(Option<DateTime>)
:The time at which the logs should start. The time range specified is inclusive of the start time.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:The time at which the logs should end. The time range specified is inclusive of the end time.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the domain.
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
- On success, responds with
GenerateAccessLogsOutput
with field(s):log_url(Option<String>)
:The pre-signed URL for the requested access logs.
- On failure, responds with
SdkError<GenerateAccessLogsError>
Constructs a fluent builder for the GetApp
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
- On success, responds with
GetAppOutput
with field(s):app(Option<App>)
:Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
- On failure, responds with
SdkError<GetAppError>
Constructs a fluent builder for the GetArtifactUrl
operation.
- The fluent builder is configurable:
artifact_id(impl Into<String>)
/set_artifact_id(Option<String>)
:The unique ID for an artifact.
- On success, responds with
GetArtifactUrlOutput
with field(s):artifact_id(Option<String>)
:The unique ID for an artifact.
artifact_url(Option<String>)
:The presigned URL for the artifact.
- On failure, responds with
SdkError<GetArtifactUrlError>
Constructs a fluent builder for the GetBackendEnvironment
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique id for an Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:The name for the backend environment.
- On success, responds with
GetBackendEnvironmentOutput
with field(s):backend_environment(Option<BackendEnvironment>)
:Describes the backend environment for an Amplify app.
- On failure, responds with
SdkError<GetBackendEnvironmentError>
Constructs a fluent builder for the GetBranch
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch.
- On success, responds with
GetBranchOutput
with field(s):branch(Option<Branch>)
:The branch for an Amplify app, which maps to a third-party repository branch.
- On failure, responds with
SdkError<GetBranchError>
Constructs a fluent builder for the GetDomainAssociation
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique id for an Amplify app.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the domain.
- On success, responds with
GetDomainAssociationOutput
with field(s):domain_association(Option<DomainAssociation>)
:Describes the structure of a domain association, which associates a custom domain with an Amplify app.
- On failure, responds with
SdkError<GetDomainAssociationError>
Constructs a fluent builder for the GetJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The branch name for the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique ID for the job.
- On success, responds with
GetJobOutput
with field(s):job(Option<Job>)
:Describes an execution job for an Amplify app.
- On failure, responds with
SdkError<GetJobError>
Constructs a fluent builder for the GetWebhook
operation.
- The fluent builder is configurable:
webhook_id(impl Into<String>)
/set_webhook_id(Option<String>)
:The unique ID for a webhook.
- On success, responds with
GetWebhookOutput
with field(s):webhook(Option<Webhook>)
:Describes the structure of a webhook.
- On failure, responds with
SdkError<GetWebhookError>
Constructs a fluent builder for the ListApps
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListAppsOutput
with field(s):apps(Option<Vec<App>>)
:A list of Amplify apps.
next_token(Option<String>)
:A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.
- On failure, responds with
SdkError<ListAppsError>
Constructs a fluent builder for the ListArtifacts
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name of a branch that is part of an Amplify app.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique ID for a job.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListArtifactsOutput
with field(s):artifacts(Option<Vec<Artifact>>)
:A list of artifacts.
next_token(Option<String>)
:A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListArtifactsError>
Constructs a fluent builder for the ListBackendEnvironments
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
environment_name(impl Into<String>)
/set_environment_name(Option<String>)
:The name of the backend environment
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListBackendEnvironmentsOutput
with field(s):backend_environments(Option<Vec<BackendEnvironment>>)
:The list of backend environments for an Amplify app.
next_token(Option<String>)
:A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListBackendEnvironmentsError>
Constructs a fluent builder for the ListBranches
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListBranchesOutput
with field(s):branches(Option<Vec<Branch>>)
:A list of branches for an Amplify app.
next_token(Option<String>)
:A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListBranchesError>
Constructs a fluent builder for the ListDomainAssociations
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListDomainAssociationsOutput
with field(s):domain_associations(Option<Vec<DomainAssociation>>)
:A list of domain associations.
next_token(Option<String>)
:A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListDomainAssociationsError>
Constructs a fluent builder for the ListJobs
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for a branch.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListJobsOutput
with field(s):job_summaries(Option<Vec<JobSummary>>)
:The result structure for the list job result request.
next_token(Option<String>)
:A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListJobsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) to use to list tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:A list of tags for the specified The Amazon Resource Name (ARN).
- On failure, responds with
SdkError<ListTagsForResourceError>
Constructs a fluent builder for the ListWebhooks
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.
max_results(i32)
/set_max_results(i32)
:The maximum number of records to list in a single response.
- On success, responds with
ListWebhooksOutput
with field(s):webhooks(Option<Vec<Webhook>>)
:A list of webhooks.
next_token(Option<String>)
:A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
- On failure, responds with
SdkError<ListWebhooksError>
Constructs a fluent builder for the StartDeployment
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch, for the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The job ID for this deployment, generated by the create deployment request.
source_url(impl Into<String>)
/set_source_url(Option<String>)
:The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.
- On success, responds with
StartDeploymentOutput
with field(s):job_summary(Option<JobSummary>)
:The summary for the job.
- On failure, responds with
SdkError<StartDeploymentError>
Constructs a fluent builder for the StartJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The branch name for the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique ID for an existing job. This is required if the value of
jobType
isRETRY
.job_type(JobType)
/set_job_type(Option<JobType>)
:Describes the type for the job. The job type
RELEASE
starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job typeRETRY
retries an existing job. If the job type value isRETRY
, thejobId
is also required.job_reason(impl Into<String>)
/set_job_reason(Option<String>)
:A descriptive reason for starting this job.
commit_id(impl Into<String>)
/set_commit_id(Option<String>)
:The commit ID from a third-party repository provider for the job.
commit_message(impl Into<String>)
/set_commit_message(Option<String>)
:The commit message from a third-party repository provider for the job.
commit_time(DateTime)
/set_commit_time(Option<DateTime>)
:The commit date and time for the job.
- On success, responds with
StartJobOutput
with field(s):job_summary(Option<JobSummary>)
:The summary for the job.
- On failure, responds with
SdkError<StartJobError>
Constructs a fluent builder for the StopJob
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch, for the job.
job_id(impl Into<String>)
/set_job_id(Option<String>)
:The unique id for the job.
- On success, responds with
StopJobOutput
with field(s):job_summary(Option<JobSummary>)
:The summary for the job.
- On failure, responds with
SdkError<StopJobError>
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) to use to tag a resource.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The tags used to tag the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) to use to untag a resource.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:The tag keys to use to untag a resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Constructs a fluent builder for the UpdateApp
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
name(impl Into<String>)
/set_name(Option<String>)
:The name for an Amplify app.
description(impl Into<String>)
/set_description(Option<String>)
:The description for an Amplify app.
platform(Platform)
/set_platform(Option<Platform>)
:The platform for an Amplify app.
iam_service_role_arn(impl Into<String>)
/set_iam_service_role_arn(Option<String>)
:The AWS Identity and Access Management (IAM) service role for an Amplify app.
environment_variables(HashMap<String, String>)
/set_environment_variables(Option<HashMap<String, String>>)
:The environment variables for an Amplify app.
enable_branch_auto_build(bool)
/set_enable_branch_auto_build(Option<bool>)
:Enables branch auto-building for an Amplify app.
enable_branch_auto_deletion(bool)
/set_enable_branch_auto_deletion(Option<bool>)
:Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
enable_basic_auth(bool)
/set_enable_basic_auth(Option<bool>)
:Enables basic authorization for an Amplify app.
basic_auth_credentials(impl Into<String>)
/set_basic_auth_credentials(Option<String>)
:The basic authorization credentials for an Amplify app.
custom_rules(Vec<CustomRule>)
/set_custom_rules(Option<Vec<CustomRule>>)
:The custom redirect and rewrite rules for an Amplify app.
build_spec(impl Into<String>)
/set_build_spec(Option<String>)
:The build specification (build spec) for an Amplify app.
custom_headers(impl Into<String>)
/set_custom_headers(Option<String>)
:The custom HTTP headers for an Amplify app.
enable_auto_branch_creation(bool)
/set_enable_auto_branch_creation(Option<bool>)
:Enables automated branch creation for an Amplify app.
auto_branch_creation_patterns(Vec<String>)
/set_auto_branch_creation_patterns(Option<Vec<String>>)
:Describes the automated branch creation glob patterns for an Amplify app.
auto_branch_creation_config(AutoBranchCreationConfig)
/set_auto_branch_creation_config(Option<AutoBranchCreationConfig>)
:The automated branch creation configuration for an Amplify app.
repository(impl Into<String>)
/set_repository(Option<String>)
:The name of the repository for an Amplify app
oauth_token(impl Into<String>)
/set_oauth_token(Option<String>)
:The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
access_token(impl Into<String>)
/set_access_token(Option<String>)
:The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.
- On success, responds with
UpdateAppOutput
with field(s):app(Option<App>)
:Represents the updated Amplify app.
- On failure, responds with
SdkError<UpdateAppError>
Constructs a fluent builder for the UpdateBranch
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for the branch.
description(impl Into<String>)
/set_description(Option<String>)
:The description for the branch.
framework(impl Into<String>)
/set_framework(Option<String>)
:The framework for the branch.
stage(Stage)
/set_stage(Option<Stage>)
:Describes the current stage for the branch.
enable_notification(bool)
/set_enable_notification(Option<bool>)
:Enables notifications for the branch.
enable_auto_build(bool)
/set_enable_auto_build(Option<bool>)
:Enables auto building for the branch.
environment_variables(HashMap<String, String>)
/set_environment_variables(Option<HashMap<String, String>>)
:The environment variables for the branch.
basic_auth_credentials(impl Into<String>)
/set_basic_auth_credentials(Option<String>)
:The basic authorization credentials for the branch.
enable_basic_auth(bool)
/set_enable_basic_auth(Option<bool>)
:Enables basic authorization for the branch.
enable_performance_mode(bool)
/set_enable_performance_mode(Option<bool>)
:Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
build_spec(impl Into<String>)
/set_build_spec(Option<String>)
:The build specification (build spec) for the branch.
ttl(impl Into<String>)
/set_ttl(Option<String>)
:The content Time to Live (TTL) for the website in seconds.
display_name(impl Into<String>)
/set_display_name(Option<String>)
:The display name for a branch. This is used as the default domain prefix.
enable_pull_request_preview(bool)
/set_enable_pull_request_preview(Option<bool>)
:Enables pull request previews for this branch.
pull_request_environment_name(impl Into<String>)
/set_pull_request_environment_name(Option<String>)
:The Amplify environment name for the pull request.
backend_environment_arn(impl Into<String>)
/set_backend_environment_arn(Option<String>)
:The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- On success, responds with
UpdateBranchOutput
with field(s):branch(Option<Branch>)
:The branch for an Amplify app, which maps to a third-party repository branch.
- On failure, responds with
SdkError<UpdateBranchError>
Constructs a fluent builder for the UpdateDomainAssociation
operation.
- The fluent builder is configurable:
app_id(impl Into<String>)
/set_app_id(Option<String>)
:The unique ID for an Amplify app.
domain_name(impl Into<String>)
/set_domain_name(Option<String>)
:The name of the domain.
enable_auto_sub_domain(bool)
/set_enable_auto_sub_domain(Option<bool>)
:Enables the automated creation of subdomains for branches.
sub_domain_settings(Vec<SubDomainSetting>)
/set_sub_domain_settings(Option<Vec<SubDomainSetting>>)
:Describes the settings for the subdomain.
auto_sub_domain_creation_patterns(Vec<String>)
/set_auto_sub_domain_creation_patterns(Option<Vec<String>>)
:Sets the branch patterns for automatic subdomain creation.
auto_sub_domain_iam_role(impl Into<String>)
/set_auto_sub_domain_iam_role(Option<String>)
:The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
- On success, responds with
UpdateDomainAssociationOutput
with field(s):domain_association(Option<DomainAssociation>)
:Describes a domain association, which associates a custom domain with an Amplify app.
- On failure, responds with
SdkError<UpdateDomainAssociationError>
Constructs a fluent builder for the UpdateWebhook
operation.
- The fluent builder is configurable:
webhook_id(impl Into<String>)
/set_webhook_id(Option<String>)
:The unique ID for a webhook.
branch_name(impl Into<String>)
/set_branch_name(Option<String>)
:The name for a branch that is part of an Amplify app.
description(impl Into<String>)
/set_description(Option<String>)
:The description for a webhook.
- On success, responds with
UpdateWebhookOutput
with field(s):webhook(Option<Webhook>)
:Describes a webhook that connects repository events to an Amplify app.
- On failure, responds with
SdkError<UpdateWebhookError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more