Backend appId Config Update - Amplify Admin UI

Backend appId Config Update

A configuration object that contains the authentication resources required for a user to access the Amplify Admin UI.

URI

/prod/backend/appId/config/update

HTTP methods

POST

Operation ID: UpdateBackendConfig

Updates the AWS resources required to access the Amplify Admin UI.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200BackendConfigRespObj

200 response

400BadRequestException

400 response

404NotFoundException

404 response

429LimitExceededException

429 response

504InternalServiceException

504 response

OPTIONS

Enables CORS by returning the correct headers.

Path parameters
NameTypeRequiredDescription
appIdStringTrue

The app ID.

Responses
Status codeResponse modelDescription
200None

200 response

Schemas

Request bodies

Response bodies

{ "backendManagerAppId": "string", "loginAuthConfig": { "aws_user_pools_id": "string", "aws_cognito_identity_pool_id": "string", "aws_cognito_region": "string", "aws_user_pools_web_client_id": "string" }, "appId": "string", "error": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string", "limitType": "string" }
{ "message": "string" }

Properties

BackendConfigRespObj

The response object for this operation.

PropertyTypeRequiredDescription
appId

string

False

The app ID.

backendManagerAppId

string

False

The app ID for the backend manager.

error

string

False

If the request fails, this error is returned.

loginAuthConfig

LoginAuthConfigReqObj

False

Describes the Amazon Cognito configurations for the Admin UI auth resource to log in with.

BadRequestException

An error returned if a request is not formed properly.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

InternalServiceException

An error returned if there's a temporary issue with the service.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request failed.

LimitExceededException

An error that is returned when a limit of a specific type has been exceeded.

PropertyTypeRequiredDescription
limitType

string

False

The type of limit that was exceeded.

message

string

False

An error message to inform that the request has failed.

LoginAuthConfigReqObj

The request object for this operation.

PropertyTypeRequiredDescription
aws_cognito_identity_pool_id

string

False

The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization.

aws_cognito_region

string

False

The AWS Region for the Amplify Admin UI login.

aws_user_pools_id

string

False

The Amazon Cognito user pool ID used for Amplify Admin UI login authentication.

aws_user_pools_web_client_id

string

False

The web client ID for the Amazon Cognito user pools.

NotFoundException

An error returned when a specific resource type is not found.

PropertyTypeRequiredDescription
message

string

False

An error message to inform that the request has failed.

resourceType

string

False

The type of resource that is not found.

UpdateBackendConfigReqObj

The request object for this operation.

PropertyTypeRequiredDescription
loginAuthConfig

LoginAuthConfigReqObj

False

Describes the Amazon Cognito configuration for Admin UI access.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

UpdateBackendConfig