get-app¶
Description¶
Returns an existing Amplify app by appID.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-app
--app-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--app-id (string)
The unique ID for an Amplify app.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
app -> (structure)
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
appId -> (string)
The unique ID of the Amplify app.
appArn -> (string)
The Amazon Resource Name (ARN) of the Amplify app.
name -> (string)
The name for the Amplify app.
tags -> (map)
The tag for the Amplify app.
key -> (string)
value -> (string)
description -> (string)
The description for the Amplify app.
repository -> (string)
The repository for the Amplify app.
platform -> (string)
The platform for the Amplify app.
createTime -> (timestamp)
Creates a date and time for the Amplify app.
updateTime -> (timestamp)
Updates the date and time for the Amplify app.
iamServiceRoleArn -> (string)
The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
environmentVariables -> (map)
The environment variables for the Amplify app.
key -> (string)
value -> (string)
defaultDomain -> (string)
The default domain for the Amplify app.
enableBranchAutoBuild -> (boolean)
Enables the auto-building of branches for the Amplify app.
enableBranchAutoDeletion -> (boolean)
Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
enableBasicAuth -> (boolean)
Enables basic authorization for the Amplify app’s branches.
basicAuthCredentials -> (string)
The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format
user:password.customRules -> (list)
Describes the custom redirect and rewrite rules for the Amplify app.
(structure)
Describes a custom rewrite or redirect rule.
source -> (string)
The source pattern for a URL rewrite or redirect rule.
target -> (string)
The target pattern for a URL rewrite or redirect rule.
status -> (string)
The status code for a URL rewrite or redirect rule.
200
Represents a 200 rewrite rule.
301
Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
302
Represents a 302 temporary redirect rule.
404
Represents a 404 redirect rule.
404-200
Represents a 404 rewrite rule.
condition -> (string)
The condition for a URL rewrite or redirect rule, such as a country code.
productionBranch -> (structure)
Describes the information about a production branch of the Amplify app.
lastDeployTime -> (timestamp)
The last deploy time of the production branch.
status -> (string)
The status of the production branch.
thumbnailUrl -> (string)
The thumbnail URL for the production branch.
branchName -> (string)
The branch name for the production branch.
buildSpec -> (string)
Describes the content of the build specification (build spec) for the Amplify app.
customHeaders -> (string)
Describes the custom HTTP headers for the Amplify app.
enableAutoBranchCreation -> (boolean)
Enables automated branch creation for the Amplify app.
autoBranchCreationPatterns -> (list)
Describes the automated branch creation glob patterns for the Amplify app.
(string)
autoBranchCreationConfig -> (structure)
Describes the automated branch creation configuration for the Amplify app.
stage -> (string)
Describes the current stage for the autocreated branch.
framework -> (string)
The framework for the autocreated branch.
enableAutoBuild -> (boolean)
Enables auto building for the autocreated branch.
environmentVariables -> (map)
The environment variables for the autocreated branch.
key -> (string)
value -> (string)
basicAuthCredentials -> (string)
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format
user:password.enableBasicAuth -> (boolean)
Enables basic authorization for the autocreated branch.
enablePerformanceMode -> (boolean)
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
buildSpec -> (string)
The build specification (build spec) for the autocreated branch.
enablePullRequestPreview -> (boolean)
Enables pull request previews for the autocreated branch.
pullRequestEnvironmentName -> (string)
The Amplify environment name for the pull request.