- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
AmplifyBackendClient
AWS Amplify Admin API
Installation
npm install @aws-sdk/client-amplifybackend
yarn add @aws-sdk/client-amplifybackend
pnpm add @aws-sdk/client-amplifybackend
AmplifyBackendClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CloneBackendCommand | This operation clones an existing backend. |
CreateBackendAPICommand | Creates a new backend API resource. |
CreateBackendAuthCommand | Creates a new backend authentication resource. |
CreateBackendCommand | This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. |
CreateBackendConfigCommand | Creates a config object for a backend. |
CreateBackendStorageCommand | Creates a backend storage resource. |
CreateTokenCommand | Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. |
DeleteBackendAPICommand | Deletes an existing backend API resource. |
DeleteBackendAuthCommand | Deletes an existing backend authentication resource. |
DeleteBackendCommand | Removes an existing environment from your Amplify project. |
DeleteBackendStorageCommand | Removes the specified backend storage resource. |
DeleteTokenCommand | Deletes the challenge token based on the given appId and sessionId. |
GenerateBackendAPIModelsCommand | Generates a model schema for an existing backend API resource. |
GetBackendAPICommand | Gets the details for a backend API. |
GetBackendAPIModelsCommand | Gets a model introspection schema for an existing backend API resource. |
GetBackendAuthCommand | Gets a backend auth details. |
GetBackendCommand | Provides project-level details for your Amplify UI project. |
GetBackendJobCommand | Returns information about a specific job. |
GetBackendStorageCommand | Gets details for a backend storage resource. |
GetTokenCommand | Gets the challenge token based on the given appId and sessionId. |
ImportBackendAuthCommand | Imports an existing backend authentication resource. |
ImportBackendStorageCommand | Imports an existing backend storage resource. |
ListBackendJobsCommand | Lists the jobs for the backend of an Amplify app. |
ListS3BucketsCommand | The list of S3 buckets in your account. |
RemoveAllBackendsCommand | Removes all backend environments from your Amplify project. |
RemoveBackendConfigCommand | Removes the AWS resources required to access the Amplify Admin UI. |
UpdateBackendAPICommand | Updates an existing backend API resource. |
UpdateBackendAuthCommand | Updates an existing backend authentication resource. |
UpdateBackendConfigCommand | Updates the AWS resources required to access the Amplify Admin UI. |
UpdateBackendJobCommand | Updates a specific job. |
UpdateBackendStorageCommand | Updates an existing backend storage resource. |
AmplifyBackendClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: AmplifyBackendClientConfig