AWS CLI Command Reference

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 . migration-hub-refactor-spaces ]

get-application

Description

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

See also: AWS API Documentation

Synopsis

  get-application
--application-identifier <value>
--environment-identifier <value>
[--cli-input-json <value>]
[--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>]

Options

--application-identifier (string)

The ID of the application.

--environment-identifier (string)

The ID of the environment.

--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.

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

--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.

Output

ApiGatewayProxy -> (structure)

The endpoint URL of the API Gateway proxy.

ApiGatewayId -> (string)

The resource ID of the API Gateway for the proxy.

EndpointType -> (string)

The type of API Gateway endpoint created.

NlbArn -> (string)

The Amazon Resource Name (ARN) of the Network Load Balancer configured by the API Gateway proxy.

NlbName -> (string)

The name of the Network Load Balancer that is configured by the API Gateway proxy.

ProxyUrl -> (string)

The endpoint URL of the API Gateway proxy.

StageName -> (string)

The name of the API Gateway stage. The name defaults to prod .

VpcLinkId -> (string)

The VpcLink ID of the API Gateway proxy.

ApplicationId -> (string)

The unique identifier of the application.

Arn -> (string)

The Amazon Resource Name (ARN) of the application.

CreatedByAccountId -> (string)

The Amazon Web Services account ID of the application creator.

CreatedTime -> (timestamp)

A timestamp that indicates when the application is created.

EnvironmentId -> (string)

The unique identifier of the environment.

Error -> (structure)

Any error associated with the application resource.

AccountId -> (string)

The Amazon Web Services account ID of the resource owner.

AdditionalDetails -> (map)

Additional details about the error.

key -> (string)

value -> (string)

Code -> (string)

The error code associated with the error.

Message -> (string)

The message associated with the error.

ResourceIdentifier -> (string)

The ID of the resource.

ResourceType -> (string)

The type of resource.

LastUpdatedTime -> (timestamp)

A timestamp that indicates when the application was last updated.

Name -> (string)

The name of the application.

OwnerAccountId -> (string)

The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID).

ProxyType -> (string)

The proxy type of the proxy created within the application.

State -> (string)

The current state of the application.

Tags -> (map)

The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

key -> (string)

value -> (string)

VpcId -> (string)

The ID of the virtual private cloud (VPC).