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

update-environment

Description

Updates the specified environment in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  update-environment
[--description <value>]
--domain-identifier <value>
[--glossary-terms <value>]
--identifier <value>
[--name <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

--description (string)

The description to be updated as part of the UpdateEnvironment action.

--domain-identifier (string)

The identifier of the domain in which the environment is to be updated.

--glossary-terms (list)

The glossary terms to be updated as part of the UpdateEnvironment action.

(string)

Syntax:

"string" "string" ...

--identifier (string)

The identifier of the environment that is to be updated.

--name (string)

The name to be updated as part of the UpdateEnvironment action.

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

awsAccountId -> (string)

The identifier of the Amazon Web Services account in which the environment is to be updated.

awsAccountRegion -> (string)

The Amazon Web Services Region in which the environment is updated.

createdAt -> (timestamp)

The timestamp of when the environment was created.

createdBy -> (string)

The Amazon DataZone user who created the environment.

deploymentProperties -> (structure)

The deployment properties to be updated as part of the UpdateEnvironment action.

endTimeoutMinutes -> (integer)

The end timeout of the environment blueprint deployment.

startTimeoutMinutes -> (integer)

The start timeout of the environment blueprint deployment.

description -> (string)

The description to be updated as part of the UpdateEnvironment action.

domainId -> (string)

The identifier of the domain in which the environment is to be updated.

environmentActions -> (list)

The environment actions to be updated as part of the UpdateEnvironment action.

(structure)

The configurable action of a Amazon DataZone environment.

auth -> (string)

The authentication type of a configurable action of a Amazon DataZone environment.

parameters -> (list)

The parameters of a configurable action in a Amazon DataZone environment.

(structure)

The details of the parameters for the configurable environment action.

key -> (string)

The key of the configurable action parameter.

value -> (string)

The value of the configurable action parameter.

type -> (string)

The type of a configurable action in a Amazon DataZone environment.

environmentBlueprintId -> (string)

The blueprint identifier of the environment.

environmentProfileId -> (string)

The profile identifier of the environment.

glossaryTerms -> (list)

The glossary terms to be updated as part of the UpdateEnvironment action.

(string)

id -> (string)

The identifier of the environment that is to be updated.

lastDeployment -> (structure)

The last deployment of the environment.

deploymentId -> (string)

The identifier of the last deployment of the environment.

deploymentStatus -> (string)

The status of the last deployment of the environment.

deploymentType -> (string)

The type of the last deployment of the environment.

failureReason -> (structure)

The failure reason of the last deployment of the environment.

code -> (string)

The error code for the failure reason for the environment deployment.

message -> (string)

The error message for the failure reason for the environment deployment.

isDeploymentComplete -> (boolean)

Specifies whether the last deployment of the environment is complete.

messages -> (list)

The messages of the last deployment of the environment.

(string)

name -> (string)

The name to be updated as part of the UpdateEnvironment action.

projectId -> (string)

The project identifier of the environment.

provider -> (string)

The provider identifier of the environment.

provisionedResources -> (list)

The provisioned resources to be updated as part of the UpdateEnvironment action.

(structure)

The details of a provisioned resource of this Amazon DataZone environment.

name -> (string)

The name of a provisioned resource of this Amazon DataZone environment.

provider -> (string)

The provider of a provisioned resource of this Amazon DataZone environment.

type -> (string)

The type of a provisioned resource of this Amazon DataZone environment.

value -> (string)

The value of a provisioned resource of this Amazon DataZone environment.

provisioningProperties -> (tagged union structure)

The provisioning properties to be updated as part of the UpdateEnvironment action.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: cloudFormation.

cloudFormation -> (structure)

The cloud formation properties included as part of the provisioning properties of an environment blueprint.

templateUrl -> (string)

The template URL of the cloud formation provisioning properties of the environment blueprint.

status -> (string)

The status to be updated as part of the UpdateEnvironment action.

updatedAt -> (timestamp)

The timestamp of when the environment was updated.

userParameters -> (list)

The user parameters to be updated as part of the UpdateEnvironment action.

(structure)

The details of user parameters of an environment blueprint.

defaultValue -> (string)

The default value of the parameter.

description -> (string)

The description of the parameter.

fieldType -> (string)

The filed type of the parameter.

isEditable -> (boolean)

Specifies whether the parameter is editable.

isOptional -> (boolean)

Specifies whether the custom parameter is optional.

keyName -> (string)

The key name of the parameter.