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

get-dev-environment

Description

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

See also: AWS API Documentation

Synopsis

  get-dev-environment
--space-name <value>
--project-name <value>
--id <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

--space-name (string)

The name of the space.

--project-name (string)

The name of the project in the space.

--id (string)

The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use ListDevEnvironments .

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

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

spaceName -> (string)

The name of the space.

projectName -> (string)

The name of the project in the space.

id -> (string)

The system-generated unique ID of the Dev Environment.

lastUpdatedTime -> (timestamp)

The time when the Dev Environment was last updated, in coordinated universal time (UTC) timestamp format as specified in RFC 3339 .

creatorId -> (string)

The system-generated unique ID of the user who created the Dev Environment.

status -> (string)

The current status of the Dev Environment.

statusReason -> (string)

The reason for the status.

repositories -> (list)

The source repository that contains the branch cloned into the Dev Environment.

(structure)

Information about the source repsitory for a Dev Environment.

repositoryName -> (string)

The name of the source repository.

branchName -> (string)

The name of the branch in a source repository cloned into the Dev Environment.

alias -> (string)

The user-specified alias for the Dev Environment.

ides -> (list)

Information about the integrated development environment (IDE) configured for the Dev Environment.

(structure)

Information about an integrated development environment (IDE) used in a Dev Environment.

runtime -> (string)

A link to the IDE runtime image.

name -> (string)

The name of the IDE.

instanceType -> (string)

The Amazon EC2 instace type to use for the Dev Environment.

inactivityTimeoutMinutes -> (integer)

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes.

persistentStorage -> (structure)

Information about the amount of storage allocated to the Dev Environment. By default, a Dev Environment is configured to have 16GB of persistent storage.

sizeInGiB -> (integer)

The size of the persistent storage in gigabytes (specifically GiB).

Note

Valid values for storage are based on memory sizes in 16GB increments. Valid values are 16, 32, and 64.

vpcConnectionName -> (string)

The name of the connection used to connect to Amazon VPC used when the Dev Environment was created, if any.