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 ]

create-project

Description

Creates an Amazon DataZone project.

See also: AWS API Documentation

Synopsis

  create-project
--domain-identifier <value>
--name <value>
[--description <value>]
[--resource-tags <value>]
[--glossary-terms <value>]
[--domain-unit-id <value>]
[--project-profile-id <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>]
[--v2-debug]

Options

--domain-identifier (string)

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

--name (string)

The name of the Amazon DataZone project.

--description (string)

The description of the Amazon DataZone project.

--resource-tags (map)

The resource tags of the project.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--glossary-terms (list)

The glossary terms that can be used in this Amazon DataZone project.

(string)

Syntax:

"string" "string" ...

--domain-unit-id (string)

The ID of the domain unit. This parameter is not required and if it is not specified, then the project is created at the root domain unit level.

--project-profile-id (string)

The ID of the project profile.

--user-parameters (list)

The user parameters of the project.

(structure)

The environment configuration user parameters.

environmentId -> (string)

The ID of the environment.

environmentResolvedAccount -> (structure)

Specifies the account/Region that is to be used during project creation for a particular blueprint.

awsAccountId -> (string)

The ID of the resolved account.

regionName -> (string)

The name of the resolved Region.

sourceAccountPoolId -> (string)

The ID of the account pool.

environmentConfigurationName -> (string)

The environment configuration name.

environmentParameters -> (list)

The environment parameters.

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

environmentId=string,environmentResolvedAccount={awsAccountId=string,regionName=string,sourceAccountPoolId=string},environmentConfigurationName=string,environmentParameters=[{name=string,value=string},{name=string,value=string}] ...

JSON Syntax:

[
  {
    "environmentId": "string",
    "environmentResolvedAccount": {
      "awsAccountId": "string",
      "regionName": "string",
      "sourceAccountPoolId": "string"
    },
    "environmentConfigurationName": "string",
    "environmentParameters": [
      {
        "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. 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

domainId -> (string)

The identifier of the Amazon DataZone domain in which the project was created.

id -> (string)

The ID of the Amazon DataZone project.

name -> (string)

The name of the project.

description -> (string)

The description of the project.

projectStatus -> (string)

The status of the Amazon DataZone project that was created.

failureReasons -> (list)

Specifies the error message that is returned if the operation cannot be successfully completed.

(structure)

Specifies the error message that is returned if the operation cannot be successfully completed.

code -> (string)

The code of the project deletion error.

message -> (string)

The message of the project deletion error.

createdBy -> (string)

The Amazon DataZone user who created the project.

createdAt -> (timestamp)

The timestamp of when the project was created.

lastUpdatedAt -> (timestamp)

The timestamp of when the project was last updated.

resourceTags -> (list)

The resource tags of the project.

(structure)

The resource tag of the project.

key -> (string)

The key of the resource tag of the project.

value -> (string)

The value of the resource tag of the project.

source -> (string)

The source of the resource tag of the project.

glossaryTerms -> (list)

The glossary terms that can be used in the project.

(string)

domainUnitId -> (string)

The ID of the domain unit.

projectProfileId -> (string)

The project profile ID.

userParameters -> (list)

The user parameters of the project.

(structure)

The environment configuration user parameters.

environmentId -> (string)

The ID of the environment.

environmentResolvedAccount -> (structure)

Specifies the account/Region that is to be used during project creation for a particular blueprint.

awsAccountId -> (string)

The ID of the resolved account.

regionName -> (string)

The name of the resolved Region.

sourceAccountPoolId -> (string)

The ID of the account pool.

environmentConfigurationName -> (string)

The environment configuration name.

environmentParameters -> (list)

The environment parameters.

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

environmentDeploymentDetails -> (structure)

The environment deployment details.

overallDeploymentStatus -> (string)

The overall deployment status of the environment.

environmentFailureReasons -> (map)

Environment failure reasons.

key -> (string)

value -> (list)

(structure)

The failure reasons for the environment deployment.

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.