AmplifyBackend 2020-08-11
- Client: Aws\AmplifyBackend\AmplifyBackendClient
- Service ID: amplifybackend
- Version: 2020-08-11
This page describes the parameters and results for the operations of the AmplifyBackend (2020-08-11), and shows how to use the Aws\AmplifyBackend\AmplifyBackendClient object to call the described operations. This documentation is specific to the 2020-08-11 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CloneBackend ( array $params = [] )
This operation clones an existing backend.
- CreateBackend ( array $params = [] )
This operation creates a backend for an Amplify app.
- CreateBackendAPI ( array $params = [] )
Creates a new backend API resource.
- CreateBackendAuth ( array $params = [] )
Creates a new backend authentication resource.
- CreateBackendConfig ( array $params = [] )
Creates a config object for a backend.
- CreateBackendStorage ( array $params = [] )
Creates a backend storage resource.
- CreateToken ( array $params = [] )
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
- DeleteBackend ( array $params = [] )
Removes an existing environment from your Amplify project.
- DeleteBackendAPI ( array $params = [] )
Deletes an existing backend API resource.
- DeleteBackendAuth ( array $params = [] )
Deletes an existing backend authentication resource.
- DeleteBackendStorage ( array $params = [] )
Removes the specified backend storage resource.
- DeleteToken ( array $params = [] )
Deletes the challenge token based on the given appId and sessionId.
- GenerateBackendAPIModels ( array $params = [] )
Generates a model schema for an existing backend API resource.
- GetBackend ( array $params = [] )
Provides project-level details for your Amplify UI project.
- GetBackendAPI ( array $params = [] )
Gets the details for a backend API.
- GetBackendAPIModels ( array $params = [] )
Gets a model introspection schema for an existing backend API resource.
- GetBackendAuth ( array $params = [] )
Gets a backend auth details.
- GetBackendJob ( array $params = [] )
Returns information about a specific job.
- GetBackendStorage ( array $params = [] )
Gets details for a backend storage resource.
- GetToken ( array $params = [] )
Gets the challenge token based on the given appId and sessionId.
- ImportBackendAuth ( array $params = [] )
Imports an existing backend authentication resource.
- ImportBackendStorage ( array $params = [] )
Imports an existing backend storage resource.
- ListBackendJobs ( array $params = [] )
Lists the jobs for the backend of an Amplify app.
- ListS3Buckets ( array $params = [] )
The list of S3 buckets in your account.
- RemoveAllBackends ( array $params = [] )
Removes all backend environments from your Amplify project.
- RemoveBackendConfig ( array $params = [] )
Removes the AWS resources required to access the Amplify Admin UI.
- UpdateBackendAPI ( array $params = [] )
Updates an existing backend API resource.
- UpdateBackendAuth ( array $params = [] )
Updates an existing backend authentication resource.
- UpdateBackendConfig ( array $params = [] )
Updates the AWS resources required to access the Amplify Admin UI.
- UpdateBackendJob ( array $params = [] )
Updates a specific job.
- UpdateBackendStorage ( array $params = [] )
Updates an existing backend storage resource.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CloneBackend
$result = $client->cloneBackend([/* ... */]); $promise = $client->cloneBackendAsync([/* ... */]);
This operation clones an existing backend.
Parameter Syntax
$result = $client->cloneBackend([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'TargetEnvironmentName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateBackend
$result = $client->createBackend([/* ... */]); $promise = $client->createBackendAsync([/* ... */]);
This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.
Parameter Syntax
$result = $client->createBackend([
'AppId' => '<string>', // REQUIRED
'AppName' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [
],
'ResourceName' => '<string>',
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- AppName
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Type: ResourceConfig structure
- ResourceName
-
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateBackendAPI
$result = $client->createBackendAPI([/* ... */]); $promise = $client->createBackendAPIAsync([/* ... */]);
Creates a new backend API resource.
Parameter Syntax
$result = $client->createBackendAPI([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [ // REQUIRED
'AdditionalAuthTypes' => [
[
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
// ...
],
'ApiName' => '<string>',
'ConflictResolution' => [
'ResolutionStrategy' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
],
'DefaultAuthType' => [
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
'Service' => '<string>',
'TransformSchema' => '<string>',
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Required: Yes
- Type: BackendAPIResourceConfig structure
The resource config for the data model, configured as a part of the Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateBackendAuth
$result = $client->createBackendAuth([/* ... */]); $promise = $client->createBackendAuthAsync([/* ... */]);
Creates a new backend authentication resource.
Parameter Syntax
$result = $client->createBackendAuth([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [ // REQUIRED
'AuthResources' => 'USER_POOL_ONLY|IDENTITY_POOL_AND_USER_POOL', // REQUIRED
'IdentityPoolConfigs' => [
'IdentityPoolName' => '<string>', // REQUIRED
'UnauthenticatedLogin' => true || false, // REQUIRED
],
'Service' => 'COGNITO', // REQUIRED
'UserPoolConfigs' => [ // REQUIRED
'ForgotPassword' => [
'DeliveryMethod' => 'EMAIL|SMS', // REQUIRED
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
'Mfa' => [
'MFAMode' => 'ON|OFF|OPTIONAL', // REQUIRED
'Settings' => [
'MfaTypes' => ['<string>', ...],
'SmsMessage' => '<string>',
],
],
'OAuth' => [
'DomainPrefix' => '<string>',
'OAuthGrantType' => 'CODE|IMPLICIT', // REQUIRED
'OAuthScopes' => ['<string>', ...], // REQUIRED
'RedirectSignInURIs' => ['<string>', ...], // REQUIRED
'RedirectSignOutURIs' => ['<string>', ...], // REQUIRED
'SocialProviderSettings' => [
'Facebook' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'Google' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'LoginWithAmazon' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'SignInWithApple' => [
'ClientId' => '<string>',
'KeyId' => '<string>',
'PrivateKey' => '<string>',
'TeamId' => '<string>',
],
],
],
'PasswordPolicy' => [
'AdditionalConstraints' => ['<string>', ...],
'MinimumLength' => <float>, // REQUIRED
],
'RequiredSignUpAttributes' => ['<string>', ...], // REQUIRED
'SignInMethod' => 'EMAIL|EMAIL_AND_PHONE_NUMBER|PHONE_NUMBER|USERNAME', // REQUIRED
'UserPoolName' => '<string>', // REQUIRED
'VerificationMessage' => [
'DeliveryMethod' => 'EMAIL|SMS', // REQUIRED
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
],
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Required: Yes
- Type: CreateBackendAuthResourceConfig structure
Defines the resource configuration when creating an auth resource in your Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateBackendConfig
$result = $client->createBackendConfig([/* ... */]); $promise = $client->createBackendConfigAsync([/* ... */]);
Creates a config object for a backend.
Parameter Syntax
$result = $client->createBackendConfig([
'AppId' => '<string>', // REQUIRED
'BackendManagerAppId' => '<string>',
]);
Parameter Details
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'JobId' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateBackendStorage
$result = $client->createBackendStorage([/* ... */]); $promise = $client->createBackendStorageAsync([/* ... */]);
Creates a backend storage resource.
Parameter Syntax
$result = $client->createBackendStorage([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [ // REQUIRED
'BucketName' => '<string>',
'Permissions' => [ // REQUIRED
'Authenticated' => ['<string>', ...], // REQUIRED
'UnAuthenticated' => ['<string>', ...],
],
'ServiceName' => 'S3', // REQUIRED
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Required: Yes
- Type: CreateBackendStorageResourceConfig structure
The resource configuration for creating backend storage.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'JobId' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
CreateToken
$result = $client->createToken([/* ... */]); $promise = $client->createTokenAsync([/* ... */]);
Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.
Parameter Syntax
$result = $client->createToken([
'AppId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AppId' => '<string>',
'ChallengeCode' => '<string>',
'SessionId' => '<string>',
'Ttl' => '<string>',
]
Result Details
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
DeleteBackend
$result = $client->deleteBackend([/* ... */]); $promise = $client->deleteBackendAsync([/* ... */]);
Removes an existing environment from your Amplify project.
Parameter Syntax
$result = $client->deleteBackend([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
DeleteBackendAPI
$result = $client->deleteBackendAPI([/* ... */]); $promise = $client->deleteBackendAPIAsync([/* ... */]);
Deletes an existing backend API resource.
Parameter Syntax
$result = $client->deleteBackendAPI([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [
'AdditionalAuthTypes' => [
[
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
// ...
],
'ApiName' => '<string>',
'ConflictResolution' => [
'ResolutionStrategy' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
],
'DefaultAuthType' => [
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
'Service' => '<string>',
'TransformSchema' => '<string>',
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
The resource config for the data model, configured as a part of the Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
DeleteBackendAuth
$result = $client->deleteBackendAuth([/* ... */]); $promise = $client->deleteBackendAuthAsync([/* ... */]);
Deletes an existing backend authentication resource.
Parameter Syntax
$result = $client->deleteBackendAuth([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
DeleteBackendStorage
$result = $client->deleteBackendStorage([/* ... */]); $promise = $client->deleteBackendStorageAsync([/* ... */]);
Removes the specified backend storage resource.
Parameter Syntax
$result = $client->deleteBackendStorage([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
'ServiceName' => 'S3', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'JobId' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
DeleteToken
$result = $client->deleteToken([/* ... */]); $promise = $client->deleteTokenAsync([/* ... */]);
Deletes the challenge token based on the given appId and sessionId.
Parameter Syntax
$result = $client->deleteToken([
'AppId' => '<string>', // REQUIRED
'SessionId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'IsSuccess' => true || false,
]
Result Details
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GenerateBackendAPIModels
$result = $client->generateBackendAPIModels([/* ... */]); $promise = $client->generateBackendAPIModelsAsync([/* ... */]);
Generates a model schema for an existing backend API resource.
Parameter Syntax
$result = $client->generateBackendAPIModels([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackend
$result = $client->getBackend([/* ... */]); $promise = $client->getBackendAsync([/* ... */]);
Provides project-level details for your Amplify UI project.
Parameter Syntax
$result = $client->getBackend([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>',
]);
Parameter Details
Result Syntax
[
'AmplifyFeatureFlags' => '<string>',
'AmplifyMetaConfig' => '<string>',
'AppId' => '<string>',
'AppName' => '<string>',
'BackendEnvironmentList' => ['<string>', ...],
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackendAPI
$result = $client->getBackendAPI([/* ... */]); $promise = $client->getBackendAPIAsync([/* ... */]);
Gets the details for a backend API.
Parameter Syntax
$result = $client->getBackendAPI([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [
'AdditionalAuthTypes' => [
[
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
// ...
],
'ApiName' => '<string>',
'ConflictResolution' => [
'ResolutionStrategy' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
],
'DefaultAuthType' => [
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
'Service' => '<string>',
'TransformSchema' => '<string>',
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
The resource config for the data model, configured as a part of the Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'ResourceConfig' => [
'AdditionalAuthTypes' => [
[
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
// ...
],
'ApiName' => '<string>',
'ConflictResolution' => [
'ResolutionStrategy' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
],
'DefaultAuthType' => [
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
'Service' => '<string>',
'TransformSchema' => '<string>',
],
'ResourceName' => '<string>',
]
Result Details
Members
- AppId
-
- Type: string
- BackendEnvironmentName
-
- Type: string
- Error
-
- Type: string
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
The resource config for the data model, configured as a part of the Amplify project.
- ResourceName
-
- Type: string
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackendAPIModels
$result = $client->getBackendAPIModels([/* ... */]); $promise = $client->getBackendAPIModelsAsync([/* ... */]);
Gets a model introspection schema for an existing backend API resource.
Parameter Syntax
$result = $client->getBackendAPIModels([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'ModelIntrospectionSchema' => '<string>',
'Models' => '<string>',
'Status' => 'LATEST|STALE',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackendAuth
$result = $client->getBackendAuth([/* ... */]); $promise = $client->getBackendAuthAsync([/* ... */]);
Gets a backend auth details.
Parameter Syntax
$result = $client->getBackendAuth([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'ResourceConfig' => [
'AuthResources' => 'USER_POOL_ONLY|IDENTITY_POOL_AND_USER_POOL',
'IdentityPoolConfigs' => [
'IdentityPoolName' => '<string>',
'UnauthenticatedLogin' => true || false,
],
'Service' => 'COGNITO',
'UserPoolConfigs' => [
'ForgotPassword' => [
'DeliveryMethod' => 'EMAIL|SMS',
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
'Mfa' => [
'MFAMode' => 'ON|OFF|OPTIONAL',
'Settings' => [
'MfaTypes' => ['<string>', ...],
'SmsMessage' => '<string>',
],
],
'OAuth' => [
'DomainPrefix' => '<string>',
'OAuthGrantType' => 'CODE|IMPLICIT',
'OAuthScopes' => ['<string>', ...],
'RedirectSignInURIs' => ['<string>', ...],
'RedirectSignOutURIs' => ['<string>', ...],
'SocialProviderSettings' => [
'Facebook' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'Google' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'LoginWithAmazon' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'SignInWithApple' => [
'ClientId' => '<string>',
'KeyId' => '<string>',
'PrivateKey' => '<string>',
'TeamId' => '<string>',
],
],
],
'PasswordPolicy' => [
'AdditionalConstraints' => ['<string>', ...],
'MinimumLength' => <float>,
],
'RequiredSignUpAttributes' => ['<string>', ...],
'SignInMethod' => 'EMAIL|EMAIL_AND_PHONE_NUMBER|PHONE_NUMBER|USERNAME',
'UserPoolName' => '<string>',
'VerificationMessage' => [
'DeliveryMethod' => 'EMAIL|SMS',
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
],
],
'ResourceName' => '<string>',
]
Result Details
Members
- AppId
-
- Type: string
- BackendEnvironmentName
-
- Type: string
- Error
-
- Type: string
- ResourceConfig
-
- Type: CreateBackendAuthResourceConfig structure
Defines the resource configuration when creating an auth resource in your Amplify project.
- ResourceName
-
- Type: string
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackendJob
$result = $client->getBackendJob([/* ... */]); $promise = $client->getBackendJobAsync([/* ... */]);
Returns information about a specific job.
Parameter Syntax
$result = $client->getBackendJob([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'JobId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'CreateTime' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
'UpdateTime' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetBackendStorage
$result = $client->getBackendStorage([/* ... */]); $promise = $client->getBackendStorageAsync([/* ... */]);
Gets details for a backend storage resource.
Parameter Syntax
$result = $client->getBackendStorage([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'ResourceConfig' => [
'BucketName' => '<string>',
'Imported' => true || false,
'Permissions' => [
'Authenticated' => ['<string>', ...],
'UnAuthenticated' => ['<string>', ...],
],
'ServiceName' => 'S3',
],
'ResourceName' => '<string>',
]
Result Details
Members
- AppId
-
- Type: string
- BackendEnvironmentName
-
- Type: string
- ResourceConfig
-
- Type: GetBackendStorageResourceConfig structure
The details for a backend storage resource.
- ResourceName
-
- Type: string
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
GetToken
$result = $client->getToken([/* ... */]); $promise = $client->getTokenAsync([/* ... */]);
Gets the challenge token based on the given appId and sessionId.
Parameter Syntax
$result = $client->getToken([
'AppId' => '<string>', // REQUIRED
'SessionId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'AppId' => '<string>',
'ChallengeCode' => '<string>',
'SessionId' => '<string>',
'Ttl' => '<string>',
]
Result Details
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
ImportBackendAuth
$result = $client->importBackendAuth([/* ... */]); $promise = $client->importBackendAuthAsync([/* ... */]);
Imports an existing backend authentication resource.
Parameter Syntax
$result = $client->importBackendAuth([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'IdentityPoolId' => '<string>',
'NativeClientId' => '<string>', // REQUIRED
'UserPoolId' => '<string>', // REQUIRED
'WebClientId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
ImportBackendStorage
$result = $client->importBackendStorage([/* ... */]); $promise = $client->importBackendStorageAsync([/* ... */]);
Imports an existing backend storage resource.
Parameter Syntax
$result = $client->importBackendStorage([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'BucketName' => '<string>',
'ServiceName' => 'S3', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'JobId' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
ListBackendJobs
$result = $client->listBackendJobs([/* ... */]); $promise = $client->listBackendJobsAsync([/* ... */]);
Lists the jobs for the backend of an Amplify app.
Parameter Syntax
$result = $client->listBackendJobs([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'JobId' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Jobs' => [
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'CreateTime' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
'UpdateTime' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Jobs
-
- Type: Array of BackendJobRespObj structures
- NextToken
-
- Type: string
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
ListS3Buckets
$result = $client->listS3Buckets([/* ... */]); $promise = $client->listS3BucketsAsync([/* ... */]);
The list of S3 buckets in your account.
Parameter Syntax
$result = $client->listS3Buckets([
'NextToken' => '<string>',
]);
Parameter Details
Result Syntax
[
'Buckets' => [
[
'CreationDate' => '<string>',
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Buckets
-
- Type: Array of S3BucketInfo structures
- NextToken
-
- Type: string
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
RemoveAllBackends
$result = $client->removeAllBackends([/* ... */]); $promise = $client->removeAllBackendsAsync([/* ... */]);
Removes all backend environments from your Amplify project.
Parameter Syntax
$result = $client->removeAllBackends([
'AppId' => '<string>', // REQUIRED
'CleanAmplifyApp' => true || false,
]);
Parameter Details
Result Syntax
[
'AppId' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
RemoveBackendConfig
$result = $client->removeBackendConfig([/* ... */]); $promise = $client->removeBackendConfigAsync([/* ... */]);
Removes the AWS resources required to access the Amplify Admin UI.
Parameter Syntax
$result = $client->removeBackendConfig([
'AppId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'Error' => '<string>',
]
Result Details
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
UpdateBackendAPI
$result = $client->updateBackendAPI([/* ... */]); $promise = $client->updateBackendAPIAsync([/* ... */]);
Updates an existing backend API resource.
Parameter Syntax
$result = $client->updateBackendAPI([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [
'AdditionalAuthTypes' => [
[
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
// ...
],
'ApiName' => '<string>',
'ConflictResolution' => [
'ResolutionStrategy' => 'OPTIMISTIC_CONCURRENCY|LAMBDA|AUTOMERGE|NONE',
],
'DefaultAuthType' => [
'Mode' => 'API_KEY|AWS_IAM|AMAZON_COGNITO_USER_POOLS|OPENID_CONNECT',
'Settings' => [
'CognitoUserPoolId' => '<string>',
'Description' => '<string>',
'ExpirationTime' => <float>,
'OpenIDAuthTTL' => '<string>',
'OpenIDClientId' => '<string>',
'OpenIDIatTTL' => '<string>',
'OpenIDIssueURL' => '<string>',
'OpenIDProviderName' => '<string>',
],
],
'Service' => '<string>',
'TransformSchema' => '<string>',
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
The resource config for the data model, configured as a part of the Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
UpdateBackendAuth
$result = $client->updateBackendAuth([/* ... */]); $promise = $client->updateBackendAuthAsync([/* ... */]);
Updates an existing backend authentication resource.
Parameter Syntax
$result = $client->updateBackendAuth([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [ // REQUIRED
'AuthResources' => 'USER_POOL_ONLY|IDENTITY_POOL_AND_USER_POOL', // REQUIRED
'IdentityPoolConfigs' => [
'UnauthenticatedLogin' => true || false,
],
'Service' => 'COGNITO', // REQUIRED
'UserPoolConfigs' => [ // REQUIRED
'ForgotPassword' => [
'DeliveryMethod' => 'EMAIL|SMS',
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
'Mfa' => [
'MFAMode' => 'ON|OFF|OPTIONAL',
'Settings' => [
'MfaTypes' => ['<string>', ...],
'SmsMessage' => '<string>',
],
],
'OAuth' => [
'DomainPrefix' => '<string>',
'OAuthGrantType' => 'CODE|IMPLICIT',
'OAuthScopes' => ['<string>', ...],
'RedirectSignInURIs' => ['<string>', ...],
'RedirectSignOutURIs' => ['<string>', ...],
'SocialProviderSettings' => [
'Facebook' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'Google' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'LoginWithAmazon' => [
'ClientId' => '<string>',
'ClientSecret' => '<string>',
],
'SignInWithApple' => [
'ClientId' => '<string>',
'KeyId' => '<string>',
'PrivateKey' => '<string>',
'TeamId' => '<string>',
],
],
],
'PasswordPolicy' => [
'AdditionalConstraints' => ['<string>', ...],
'MinimumLength' => <float>,
],
'VerificationMessage' => [
'DeliveryMethod' => 'EMAIL|SMS', // REQUIRED
'EmailSettings' => [
'EmailMessage' => '<string>',
'EmailSubject' => '<string>',
],
'SmsSettings' => [
'SmsMessage' => '<string>',
],
],
],
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Required: Yes
- Type: UpdateBackendAuthResourceConfig structure
Defines the resource configuration when updating an authentication resource in your Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
UpdateBackendConfig
$result = $client->updateBackendConfig([/* ... */]); $promise = $client->updateBackendConfigAsync([/* ... */]);
Updates the AWS resources required to access the Amplify Admin UI.
Parameter Syntax
$result = $client->updateBackendConfig([
'AppId' => '<string>', // REQUIRED
'LoginAuthConfig' => [
'AwsCognitoIdentityPoolId' => '<string>',
'AwsCognitoRegion' => '<string>',
'AwsUserPoolsId' => '<string>',
'AwsUserPoolsWebClientId' => '<string>',
],
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- LoginAuthConfig
-
- Type: LoginAuthConfigReqObj structure
The request object for this operation.
Result Syntax
[
'AppId' => '<string>',
'BackendManagerAppId' => '<string>',
'Error' => '<string>',
'LoginAuthConfig' => [
'AwsCognitoIdentityPoolId' => '<string>',
'AwsCognitoRegion' => '<string>',
'AwsUserPoolsId' => '<string>',
'AwsUserPoolsWebClientId' => '<string>',
],
]
Result Details
Members
- AppId
-
- Type: string
- BackendManagerAppId
-
- Type: string
- Error
-
- Type: string
- LoginAuthConfig
-
- Type: LoginAuthConfigReqObj structure
The request object for this operation.
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
UpdateBackendJob
$result = $client->updateBackendJob([/* ... */]); $promise = $client->updateBackendJobAsync([/* ... */]);
Updates a specific job.
Parameter Syntax
$result = $client->updateBackendJob([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'JobId' => '<string>', // REQUIRED
'Operation' => '<string>',
'Status' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'CreateTime' => '<string>',
'Error' => '<string>',
'JobId' => '<string>',
'Operation' => '<string>',
'Status' => '<string>',
'UpdateTime' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
UpdateBackendStorage
$result = $client->updateBackendStorage([/* ... */]); $promise = $client->updateBackendStorageAsync([/* ... */]);
Updates an existing backend storage resource.
Parameter Syntax
$result = $client->updateBackendStorage([
'AppId' => '<string>', // REQUIRED
'BackendEnvironmentName' => '<string>', // REQUIRED
'ResourceConfig' => [ // REQUIRED
'Permissions' => [ // REQUIRED
'Authenticated' => ['<string>', ...], // REQUIRED
'UnAuthenticated' => ['<string>', ...],
],
'ServiceName' => 'S3', // REQUIRED
],
'ResourceName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AppId
-
- Required: Yes
- Type: string
- BackendEnvironmentName
-
- Required: Yes
- Type: string
- ResourceConfig
-
- Required: Yes
- Type: UpdateBackendStorageResourceConfig structure
The resource configuration for updating backend storage.
- ResourceName
-
- Required: Yes
- Type: string
Result Syntax
[
'AppId' => '<string>',
'BackendEnvironmentName' => '<string>',
'JobId' => '<string>',
'Status' => '<string>',
]
Result Details
Members
Errors
-
An error returned when a specific resource type is not found.
-
An error returned if there's a temporary issue with the service.
-
An error that is returned when a limit of a specific type has been exceeded.
-
An error returned if a request is not formed properly.
Shapes
BackendAPIAppSyncAuthSettings
Description
The authentication settings for accessing provisioned data models in your Amplify project.
Members
- CognitoUserPoolId
-
- Type: string
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
- Description
-
- Type: string
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
- ExpirationTime
-
- Type: double
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
- OpenIDAuthTTL
-
- Type: string
The expiry time for the OpenID authentication mechanism.
- OpenIDClientId
-
- Type: string
The clientID for openID, if openID was used as an authentication setting to access your data models.
- OpenIDIatTTL
-
- Type: string
The expiry time for the OpenID authentication mechanism.
- OpenIDIssueURL
-
- Type: string
The openID issuer URL, if openID was used as an authentication setting to access your data models.
- OpenIDProviderName
-
- Type: string
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
BackendAPIAuthType
Description
Describes the auth types for your configured data models.
Members
- Mode
-
- Type: string
Describes the authentication mode.
- Settings
-
- Type: BackendAPIAppSyncAuthSettings structure
Describes settings for the authentication mode.
BackendAPICodegenReqObj
Description
The request object for this operation.
Members
BackendAPICodegenRespObj
Description
The response object sent when a backend is created.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
BackendAPIConflictResolution
Description
Describes the conflict resolution configuration for your data model configured in your Amplify project.
Members
BackendAPIReqObj
Description
The request object for this operation.
Members
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
Defines the resource configuration for the data model in your Amplify project.
- ResourceName
-
- Required: Yes
- Type: string
The name of this resource.
BackendAPIResourceConfig
Description
The resource config for the data model, configured as a part of the Amplify project.
Members
- AdditionalAuthTypes
-
- Type: Array of BackendAPIAuthType structures
Additional authentication methods used to interact with your data models.
- ApiName
-
- Type: string
The API name used to interact with the data model, configured as a part of your Amplify project.
- ConflictResolution
-
- Type: BackendAPIConflictResolution structure
The conflict resolution strategy for your data stored in the data models.
- DefaultAuthType
-
- Type: BackendAPIAuthType structure
The default authentication type for interacting with the configured data models in your Amplify project.
- Service
-
- Type: string
The service used to provision and interact with the data model.
- TransformSchema
-
- Type: string
The definition of the data model in the annotated transform of the GraphQL schema.
BackendAPIRespObj
Description
The response object sent when a backend is created.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
BackendAuthAppleProviderConfig
Description
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
Members
BackendAuthRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
BackendAuthSocialProviderConfig
Description
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
Members
BackendConfigRespObj
Description
The response object for this operation.
Members
- AppId
-
- Type: string
The app ID.
- BackendManagerAppId
-
- Type: string
The app ID for the backend manager.
- Error
-
- Type: string
If the request fails, this error is returned.
- LoginAuthConfig
-
- Type: LoginAuthConfigReqObj structure
Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.
BackendJobReqObj
Description
The request object for this operation.
Members
BackendJobRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- CreateTime
-
- Type: string
The time when the job was created.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
- UpdateTime
-
- Type: string
The time when the job was last updated.
BackendStoragePermissions
Description
Describes the read, write, and delete permissions users have against your storage S3 bucket.
Members
BackendStorageRespObj
Description
The response object for this operation.
Members
BadRequestException
Description
An error returned if a request is not formed properly.
Members
CloneBackendReqObj
Description
The request object for this operation.
Members
CloneBackendRespObj
Description
The response object sent when a backend is created.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
CreateBackendAPIReqObj
Description
The request object for this operation.
Members
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- ResourceConfig
-
- Required: Yes
- Type: BackendAPIResourceConfig structure
The resource configuration for this request.
- ResourceName
-
- Required: Yes
- Type: string
The name of this resource.
CreateBackendAuthForgotPasswordConfig
Description
(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
Members
- DeliveryMethod
-
- Required: Yes
- Type: string
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password.
- EmailSettings
-
- Type: EmailSettings structure
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
- SmsSettings
-
- Type: SmsSettings structure
(DEPRECATED) The configuration for the SMS message sent when an app user forgets their password.
CreateBackendAuthIdentityPoolConfig
Description
Describes authorization configurations for the auth resources, configured as a part of your Amplify project.
Members
CreateBackendAuthMFAConfig
Description
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
Members
- MFAMode
-
- Required: Yes
- Type: string
Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project.
- Settings
-
- Type: Settings structure
Describes the configuration settings and methods for your Amplify app users to use MFA.
CreateBackendAuthOAuthConfig
Description
Creates the OAuth configuration for your Amplify project.
Members
- DomainPrefix
-
- Type: string
The domain prefix for your Amplify app.
- OAuthGrantType
-
- Required: Yes
- Type: string
The OAuth grant type that you use to allow app users to authenticate from your Amplify app.
- OAuthScopes
-
- Required: Yes
- Type: Array of strings
List of OAuth-related flows used to allow your app users to authenticate from your Amplify app.
- RedirectSignInURIs
-
- Required: Yes
- Type: Array of strings
The redirected URI for signing in to your Amplify app.
- RedirectSignOutURIs
-
- Required: Yes
- Type: Array of strings
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
- SocialProviderSettings
-
- Type: SocialProviderSettings structure
The settings for using social providers to access your Amplify app.
CreateBackendAuthPasswordPolicyConfig
Description
The password policy configuration for the backend to your Amplify project.
Members
CreateBackendAuthReqObj
Description
The request object for this operation.
Members
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- ResourceConfig
-
- Required: Yes
- Type: CreateBackendAuthResourceConfig structure
The resource configuration for this request object.
- ResourceName
-
- Required: Yes
- Type: string
The name of this resource.
CreateBackendAuthResourceConfig
Description
Defines the resource configuration when creating an auth resource in your Amplify project.
Members
- AuthResources
-
- Required: Yes
- Type: string
Defines whether you want to configure only authentication or both authentication and authorization settings.
- IdentityPoolConfigs
-
- Type: CreateBackendAuthIdentityPoolConfig structure
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
- Service
-
- Required: Yes
- Type: string
Defines the service name to use when configuring an authentication resource in your Amplify project.
- UserPoolConfigs
-
- Required: Yes
- Type: CreateBackendAuthUserPoolConfig structure
Describes authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
CreateBackendAuthUserPoolConfig
Description
Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.
Members
- ForgotPassword
-
- Type: CreateBackendAuthForgotPasswordConfig structure
(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
- Mfa
-
- Type: CreateBackendAuthMFAConfig structure
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
- OAuth
-
- Type: CreateBackendAuthOAuthConfig structure
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
- PasswordPolicy
-
- Type: CreateBackendAuthPasswordPolicyConfig structure
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
- RequiredSignUpAttributes
-
- Required: Yes
- Type: Array of strings
The required attributes to sign up new users in the user pool.
- SignInMethod
-
- Required: Yes
- Type: string
Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.
- UserPoolName
-
- Required: Yes
- Type: string
The Amazon Cognito user pool name.
- VerificationMessage
-
- Type: CreateBackendAuthVerificationMessageConfig structure
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
CreateBackendAuthVerificationMessageConfig
Description
Creates an email or SMS verification message for the auth resource configured for your Amplify project.
Members
- DeliveryMethod
-
- Required: Yes
- Type: string
The type of verification message to send.
- EmailSettings
-
- Type: EmailSettings structure
The settings for the email message.
- SmsSettings
-
- Type: SmsSettings structure
The settings for the SMS message.
CreateBackendConfigReqObj
Description
The request object for this operation.
Members
CreateBackendConfigRespObj
Description
The response object for this operation.
Members
CreateBackendReqObj
Description
The request object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- AppName
-
- Required: Yes
- Type: string
The name of the app.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- ResourceConfig
-
- Type: ResourceConfig structure
The resource configuration for creating a backend.
- ResourceName
-
- Type: string
The name of the resource.
CreateBackendRespObj
Description
The response object sent when a backend is created.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
CreateBackendStorageReqObj
Description
The request object for this operation.
Members
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- ResourceConfig
-
- Required: Yes
- Type: CreateBackendStorageResourceConfig structure
The resource configuration for creating backend storage.
- ResourceName
-
- Required: Yes
- Type: string
The name of the storage resource.
CreateBackendStorageResourceConfig
Description
The resource configuration for creating backend storage.
Members
- BucketName
-
- Type: string
The name of the S3 bucket.
- Permissions
-
- Required: Yes
- Type: BackendStoragePermissions structure
The authorization configuration for the storage S3 bucket.
- ServiceName
-
- Required: Yes
- Type: string
The name of the storage service.
CreateTokenRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- ChallengeCode
-
- Required: Yes
- Type: string
One-time challenge code for authenticating into the Amplify Admin UI.
- SessionId
-
- Required: Yes
- Type: string
A unique ID provided when creating a new challenge token.
- Ttl
-
- Required: Yes
- Type: string
The expiry time for the one-time generated token code.
DeleteBackendRespObj
Description
The returned object for a request to delete a backend.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- JobId
-
- Type: string
The ID for the job.
- Operation
-
- Type: string
The name of the operation.
- Status
-
- Type: string
The current status of the request.
DeleteTokenRespObj
Description
The response object for this operation.
Members
EmailSettings
Description
The settings for the email message.
Members
GatewayTimeoutException
Description
An error returned if there's a temporary issue with the service.
Members
GetBackendAPIRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- ResourceConfig
-
- Type: BackendAPIResourceConfig structure
The resource configuration for this response object.
- ResourceName
-
- Type: string
The name of this resource.
GetBackendAuthReqObj
Description
The request object for this operation.
Members
GetBackendAuthRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request fails, this error is returned.
- ResourceConfig
-
- Type: CreateBackendAuthResourceConfig structure
The resource configuration for authorization requests to the backend of your Amplify project.
- ResourceName
-
- Type: string
The name of this resource.
GetBackendReqObj
Description
The request object for this operation.
Members
GetBackendRespObj
Description
The response object for this operation.
Members
- AmplifyFeatureFlags
-
- Type: string
A stringified version of the cli.json file for your Amplify project.
- AmplifyMetaConfig
-
- Type: string
A stringified version of the current configs for your Amplify project.
- AppId
-
- Required: Yes
- Type: string
The app ID.
- AppName
-
- Type: string
The name of the app.
- BackendEnvironmentList
-
- Type: Array of strings
A list of backend environments in an array.
- BackendEnvironmentName
-
- Type: string
The name of the backend environment.
- Error
-
- Type: string
If the request failed, this is the returned error.
GetBackendStorageReqObj
Description
The request object for this operation.
Members
GetBackendStorageResourceConfig
Description
The details for a backend storage resource.
Members
- BucketName
-
- Type: string
The name of the S3 bucket.
- Imported
-
- Required: Yes
- Type: boolean
Returns True if the storage resource has been imported.
- Permissions
-
- Type: BackendStoragePermissions structure
The authorization configuration for the storage S3 bucket.
- ServiceName
-
- Required: Yes
- Type: string
The name of the storage service.
GetBackendStorageRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- BackendEnvironmentName
-
- Required: Yes
- Type: string
The name of the backend environment.
- ResourceConfig
-
- Type: GetBackendStorageResourceConfig structure
The resource configuration for the backend storage resource.
- ResourceName
-
- Type: string
The name of the storage resource.
GetTokenRespObj
Description
The response object for this operation.
Members
- AppId
-
- Required: Yes
- Type: string
The app ID.
- ChallengeCode
-
- Required: Yes
- Type: string
The one-time challenge code for authenticating into the Amplify Admin UI.
- SessionId
-
- Required: Yes
- Type: string
A unique ID provided when creating a new challenge token.
- Ttl
-
- Required: Yes
- Type: string
The expiry time for the one-time generated token code.
ImportBackendAuthReqObj
Description
The request object for this operation.
Members
- IdentityPoolId
-
- Type: string
The ID of the Amazon Cognito identity pool.
- NativeClientId
-
- Required: Yes
- Type: string
The ID of the Amazon Cognito native client.
- UserPoolId
-
- Required: Yes
- Type: string
The ID of the Amazon Cognito user pool.
- WebClientId
-
- Required: Yes
- Type: string
The ID of the Amazon Cognito web client.
ImportBackendStorageReqObj
Description
The request object for this operation.
Members
InternalServiceException
Description
An error returned if there's a temporary issue with the service.
Members
LimitExceededException
Description
An error that is returned when a limit of a specific type has been exceeded.
Members
ListBackendJobReqObj
Description
The request object for this operation.
Members
- JobId
-
- Type: string
The ID for the job.
- MaxResults
-
- Type: int
The maximum number of results that you want in the response.
- NextToken
-
- Type: string
The token for the next set of results.
- Operation
-
- Type: string
Filters the list of response objects to include only those with the specified operation name.
- Status
-
- Type: string
Filters the list of response objects to include only those with the specified status.
ListBackendJobRespObj
Description
The returned list of backend jobs.
Members
- Jobs
-
- Type: Array of BackendJobRespObj structures
An array of jobs and their properties.
- NextToken
-
- Type: string
The token for the next set of results.
ListS3BucketsReqObj
Description
The request object for this operation.
Members
ListS3BucketsRespObj
Description
The response object for this operation.
Members
- Buckets
-
- Required: Yes
- Type: Array of S3BucketInfo structures
The list of S3 buckets.
- NextToken
-
- Type: string
Reserved for future use.
LoginAuthConfigReqObj
Description
The request object for this operation.
Members
- AwsCognitoIdentityPoolId
-
- Type: string
The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.
- AwsCognitoRegion
-
- Type: string
The AWS Region for the Amplify Admin UI login.
- AwsUserPoolsId
-
- Type: string
The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.
- AwsUserPoolsWebClientId
-
- Type: string
The web client ID for the Amazon Cognito user pools.
NotFoundException
Description
An error returned when a specific resource type is not found.
Members
RemoveAllBackendsReqObj
Description
The request object for this operation.
Members
RemoveAllBackendsRespObj
Description
The response object for this operation.
Members
RemoveBackendAuthReqObj
Description
The request object for this operation.
Members
RemoveBackendConfigRespObj
Description
The response object for this operation.
Members
RemoveBackendStorageReqObj
Description
The request object for this operation.
Members
ResourceConfig
Members
S3BucketInfo
Description
Describes the metadata of the S3 bucket.
Members
Settings
SmsSettings
Description
The settings for the SMS message.
Members
SocialProviderSettings
Members
-
- Type: BackendAuthSocialProviderConfig structure
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
-
- Type: BackendAuthSocialProviderConfig structure
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
- LoginWithAmazon
-
- Type: BackendAuthSocialProviderConfig structure
Describes third-party social federation configurations for allowing your app users to sign in using OAuth.
- SignInWithApple
-
- Type: BackendAuthAppleProviderConfig structure
Describes Apple social federation configurations for allowing your app users to sign in using OAuth.
TooManyRequestsException
Description
An error that is returned when a limit of a specific type has been exceeded.
Members
UpdateBackendAuthForgotPasswordConfig
Description
(DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app.
Members
- DeliveryMethod
-
- Type: string
(DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password.
- EmailSettings
-
- Type: EmailSettings structure
(DEPRECATED) The configuration for the email sent when an app user forgets their password.
- SmsSettings
-
- Type: SmsSettings structure
(DEPRECATED) The configuration for the SMS message sent when an Amplify app user forgets their password.
UpdateBackendAuthIdentityPoolConfig
Description
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
Members
UpdateBackendAuthMFAConfig
Description
Updates the multi-factor authentication (MFA) configuration for the backend of your Amplify project.
Members
- MFAMode
-
- Type: string
The MFA mode for the backend of your Amplify project.
- Settings
-
- Type: Settings structure
The settings of your MFA configuration for the backend of your Amplify project.
UpdateBackendAuthOAuthConfig
Description
The OAuth configurations for authenticating users into your Amplify app.
Members
- DomainPrefix
-
- Type: string
The Amazon Cognito domain prefix used to create a hosted UI for authentication.
- OAuthGrantType
-
- Type: string
The OAuth grant type to allow app users to authenticate from your Amplify app.
- OAuthScopes
-
- Type: Array of strings
The list of OAuth-related flows that can allow users to authenticate from your Amplify app.
- RedirectSignInURIs
-
- Type: Array of strings
Redirect URLs that OAuth uses when a user signs in to an Amplify app.
- RedirectSignOutURIs
-
- Type: Array of strings
Redirect URLs that OAuth uses when a user signs out of an Amplify app.
- SocialProviderSettings
-
- Type: SocialProviderSettings structure
Describes third-party social federation configurations for allowing your users to sign in with OAuth.
UpdateBackendAuthPasswordPolicyConfig
Description
Describes the password policy for your Amazon Cognito user pool configured as a part of your Amplify project.
Members
- AdditionalConstraints
-
- Type: Array of strings
Describes additional constraints on password requirements to sign in to the auth resource, configured as a part of your Amplify project.
- MinimumLength
-
- Type: double
Describes the minimum length of the password required to sign in to the auth resource, configured as a part of your Amplify project.
UpdateBackendAuthReqObj
Description
The request object for this operation.
Members
- ResourceConfig
-
- Required: Yes
- Type: UpdateBackendAuthResourceConfig structure
The resource configuration for this request object.
- ResourceName
-
- Required: Yes
- Type: string
The name of this resource.
UpdateBackendAuthResourceConfig
Description
Defines the resource configuration when updating an authentication resource in your Amplify project.
Members
- AuthResources
-
- Required: Yes
- Type: string
Defines the service name to use when configuring an authentication resource in your Amplify project.
- IdentityPoolConfigs
-
- Type: UpdateBackendAuthIdentityPoolConfig structure
Describes the authorization configuration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project.
- Service
-
- Required: Yes
- Type: string
Defines the service name to use when configuring an authentication resource in your Amplify project.
- UserPoolConfigs
-
- Required: Yes
- Type: UpdateBackendAuthUserPoolConfig structure
Describes the authentication configuration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project.
UpdateBackendAuthUserPoolConfig
Description
Describes the Amazon Cognito user pool configuration for the authorization resource to be configured for your Amplify project on an update.
Members
- ForgotPassword
-
- Type: UpdateBackendAuthForgotPasswordConfig structure
(DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
- Mfa
-
- Type: UpdateBackendAuthMFAConfig structure
Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.
- OAuth
-
- Type: UpdateBackendAuthOAuthConfig structure
Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.
- PasswordPolicy
-
- Type: UpdateBackendAuthPasswordPolicyConfig structure
Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.
- VerificationMessage
-
- Type: UpdateBackendAuthVerificationMessageConfig structure
Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.
UpdateBackendAuthVerificationMessageConfig
Description
Updates the configuration of the email or SMS message for the auth resource configured for your Amplify project.
Members
- DeliveryMethod
-
- Required: Yes
- Type: string
The type of verification message to send.
- EmailSettings
-
- Type: EmailSettings structure
The settings for the email message.
- SmsSettings
-
- Type: SmsSettings structure
The settings for the SMS message.
UpdateBackendConfigReqObj
Description
The request object for this operation.
Members
- LoginAuthConfig
-
- Type: LoginAuthConfigReqObj structure
Describes the Amazon Cognito configuration for Admin UI access.
UpdateBackendStorageReqObj
Description
The request object for this operation.
Members
- ResourceConfig
-
- Required: Yes
- Type: UpdateBackendStorageResourceConfig structure
The resource configuration for updating backend storage.
- ResourceName
-
- Required: Yes
- Type: string
The name of the storage resource.
UpdateBackendStorageResourceConfig
Description
The resource configuration for updating backend storage.
Members
- Permissions
-
- Required: Yes
- Type: BackendStoragePermissions structure
The authorization configuration for the storage S3 bucket.
- ServiceName
-
- Required: Yes
- Type: string
The name of the storage service.