Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . amplifybackend ]

update-backend-config

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-backend-config
--app-id <value>
[--login-auth-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The app ID.

--login-auth-config (structure)

Describes the Amazon Cognito configuration for Admin UI access.

AwsCognitoIdentityPoolId -> (string)

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

AwsCognitoRegion -> (string)

The AWS Region for the Amplify Admin UI login.

AwsUserPoolsId -> (string)

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

AwsUserPoolsWebClientId -> (string)

The web client ID for the Amazon Cognito user pools.

Shorthand Syntax:

AwsCognitoIdentityPoolId=string,AwsCognitoRegion=string,AwsUserPoolsId=string,AwsUserPoolsWebClientId=string

JSON Syntax:

{
  "AwsCognitoIdentityPoolId": "string",
  "AwsCognitoRegion": "string",
  "AwsUserPoolsId": "string",
  "AwsUserPoolsWebClientId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AppId -> (string)

The app ID.

BackendManagerAppId -> (string)

The app ID for the backend manager.

Error -> (string)

If the request fails, this error is returned.

LoginAuthConfig -> (structure)

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

AwsCognitoIdentityPoolId -> (string)

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

AwsCognitoRegion -> (string)

The AWS Region for the Amplify Admin UI login.

AwsUserPoolsId -> (string)

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

AwsUserPoolsWebClientId -> (string)

The web client ID for the Amazon Cognito user pools.