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

Description

Updates the specified environment profile in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  update-environment-profile
[--aws-account-id <value>]
[--aws-account-region <value>]
[--description <value>]
--domain-identifier <value>
--identifier <value>
[--name <value>]
[--user-parameters <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

--aws-account-id (string)

The Amazon Web Services account in which a specified environment profile is to be udpated.

--aws-account-region (string)

The Amazon Web Services Region in which a specified environment profile is to be updated.

--description (string)

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

--domain-identifier (string)

The identifier of the Amazon DataZone domain in which an environment profile is to be updated.

--identifier (string)

The identifier of the environment profile that is to be updated.

--name (string)

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

--user-parameters (list)

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

(structure)

The parameter details of an evironment profile.

name -> (string)

The name of an environment profile parameter.

value -> (string)

The value of an environment profile parameter.

Shorthand Syntax:

name=string,value=string ...

JSON Syntax:

[
  {
    "name": "string",
    "value": "string"
  }
  ...
]

--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 Amazon Web Services account in which a specified environment profile is to be udpated.

awsAccountRegion -> (string)

The Amazon Web Services Region in which a specified environment profile is to be updated.

createdAt -> (timestamp)

The timestamp of when the environment profile was created.

createdBy -> (string)

The Amazon DataZone user who created the environment profile.

description -> (string)

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

domainId -> (string)

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

environmentBlueprintId -> (string)

The identifier of the blueprint of the environment profile that is to be updated.

id -> (string)

The identifier of the environment profile that is to be udpated.

name -> (string)

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

projectId -> (string)

The identifier of the project of the environment profile that is to be updated.

updatedAt -> (timestamp)

The timestamp of when the environment profile was updated.

userParameters -> (list)

The user parameters to be updated as part of the UpdateEnvironmentProfile 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.