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

Description

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

See also: AWS API Documentation

Synopsis

  get-route
--application-identifier <value>
--environment-identifier <value>
--route-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.

--route-identifier (string)

The ID of the route.

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

AppendSourcePath -> (boolean)

If set to true , this option appends the source path to the service URL endpoint.

ApplicationId -> (string)

The ID of the application that the route belongs to.

Arn -> (string)

The Amazon Resource Name (ARN) of the route.

CreatedByAccountId -> (string)

The Amazon Web Services account ID of the route creator.

CreatedTime -> (timestamp)

The timestamp of when the route is created.

EnvironmentId -> (string)

Unique identifier of the environment.

Error -> (structure)

Any error associated with the route 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.

IncludeChildPaths -> (boolean)

Indicates whether to match all subpaths of the given source path. If this value is false , requests must match the source path exactly before they are forwarded to this route's service.

LastUpdatedTime -> (timestamp)

A timestamp that indicates when the route was last updated.

Methods -> (list)

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

(string)

OwnerAccountId -> (string)

The Amazon Web Services account ID of the route owner.

PathResourceToId -> (map)

A mapping of Amazon API Gateway path resources to resource IDs.

key -> (string)

value -> (string)

RouteId -> (string)

The unique identifier of the route.

DEFAULT : All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH : A route that is based on a URI path.

RouteType -> (string)

The type of route.

ServiceId -> (string)

The unique identifier of the service.

SourcePath -> (string)

This is the path that Refactor Spaces uses to match traffic. Paths must start with / and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path {user} represents a path parameter called 'user'.

State -> (string)

The current state of the route.

Tags -> (map)

The tags assigned to the route. 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)