Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datazone ]

create-environment-profile

Description

Creates an Amazon DataZone environment profile.

See also: AWS API Documentation

Synopsis

  create-environment-profile
--domain-identifier <value>
--name <value>
[--description <value>]
--environment-blueprint-identifier <value>
--project-identifier <value>
[--user-parameters <value>]
[--aws-account-id <value>]
[--aws-account-region <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>]
[--v2-debug]

Options

--domain-identifier (string)

The ID of the Amazon DataZone domain in which this environment profile is created.

--name (string)

The name of this Amazon DataZone environment profile.

--description (string)

The description of this Amazon DataZone environment profile.

--environment-blueprint-identifier (string)

The ID of the blueprint with which this environment profile is created.

--project-identifier (string)

The identifier of the project in which to create the environment profile.

--user-parameters (list)

The user parameters of this Amazon DataZone environment profile.

(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"
  }
  ...
]

--aws-account-id (string)

The Amazon Web Services account in which the Amazon DataZone environment is created.

--aws-account-region (string)

The Amazon Web Services region in which this environment profile is created.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

id -> (string)

The ID of this Amazon DataZone environment profile.

domainId -> (string)

The ID of the Amazon DataZone domain in which this environment profile is created.

awsAccountId -> (string)

The Amazon Web Services account ID in which this Amazon DataZone environment profile is created.

awsAccountRegion -> (string)

The Amazon Web Services region in which this Amazon DataZone environment profile is created.

createdBy -> (string)

The Amazon DataZone user who created this environment profile.

createdAt -> (timestamp)

The timestamp of when this environment profile was created.

updatedAt -> (timestamp)

The timestamp of when this environment profile was updated.

name -> (string)

The name of this Amazon DataZone environment profile.

description -> (string)

The description of this Amazon DataZone environment profile.

environmentBlueprintId -> (string)

The ID of the blueprint with which this environment profile is created.

projectId -> (string)

The ID of the Amazon DataZone project in which this environment profile is created.

userParameters -> (list)

The user parameters of this Amazon DataZone environment profile.

(structure)

The details of user parameters of an environment blueprint.

keyName -> (string)

The key name of the parameter.

description -> (string)

The description of the parameter.

fieldType -> (string)

The filed type of the parameter.

defaultValue -> (string)

The default value of the parameter.

isEditable -> (boolean)

Specifies whether the parameter is editable.

isOptional -> (boolean)

Specifies whether the custom parameter is optional.

isUpdateSupported -> (boolean)

Specifies whether a parameter value can be updated after creation.