[ aws . amplifybackend ]

get-backend-api

Description

Gets the details for a backend API.

See also: AWS API Documentation

Synopsis

  get-backend-api
--app-id <value>
--backend-environment-name <value>
[--resource-config <value>]
--resource-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--app-id (string)

The app ID.

--backend-environment-name (string)

The name of the backend environment.

--resource-config (structure)

Defines the resource configuration for the data model in your Amplify project.

AdditionalAuthTypes -> (list)

Additional authentication methods used to interact with your data models.

(structure)

Describes the auth types for your configured data models.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID was used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

ApiName -> (string)

The API name used to interact with the data model, configured as a part of your Amplify project.

ConflictResolution -> (structure)

The conflict resolution strategy for your data stored in the data models.

ResolutionStrategy -> (string)

The strategy for conflict resolution.

DefaultAuthType -> (structure)

The default authentication type for interacting with the configured data models in your Amplify project.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID was used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Service -> (string)

The service used to provision and interact with the data model.

TransformSchema -> (string)

The definition of the data model in the annotated transform of the GraphQL schema.

JSON Syntax:

{
  "AdditionalAuthTypes": [
    {
      "Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
      "Settings": {
        "CognitoUserPoolId": "string",
        "Description": "string",
        "ExpirationTime": double,
        "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": double,
      "OpenIDAuthTTL": "string",
      "OpenIDClientId": "string",
      "OpenIDIatTTL": "string",
      "OpenIDIssueURL": "string",
      "OpenIDProviderName": "string"
    }
  },
  "Service": "string",
  "TransformSchema": "string"
}

--resource-name (string)

The name of this resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

AppId -> (string)

The app ID.

BackendEnvironmentName -> (string)

The name of the backend environment.

Error -> (string)

If the request fails, this error is returned.

ResourceConfig -> (structure)

The resource configuration for this response object.

AdditionalAuthTypes -> (list)

Additional authentication methods used to interact with your data models.

(structure)

Describes the auth types for your configured data models.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID was used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

ApiName -> (string)

The API name used to interact with the data model, configured as a part of your Amplify project.

ConflictResolution -> (structure)

The conflict resolution strategy for your data stored in the data models.

ResolutionStrategy -> (string)

The strategy for conflict resolution.

DefaultAuthType -> (structure)

The default authentication type for interacting with the configured data models in your Amplify project.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID was used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID was used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

Service -> (string)

The service used to provision and interact with the data model.

TransformSchema -> (string)

The definition of the data model in the annotated transform of the GraphQL schema.

ResourceName -> (string)

The name of this resource.