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

Description¶

Creates a project profile.

Synopsis¶

  create-project-profile
--domain-identifier <value>
--name <value>
[--description <value>]
[--status <value>]
[--project-resource-tags <value>]
[--allow-custom-project-resource-tags | --no-allow-custom-project-resource-tags]
[--project-resource-tags-description <value>]
[--environment-configurations <value>]
[--domain-unit-identifier <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)

A domain ID of the project profile.

--name (string)

Project profile name.

--description (string)

A description of a project profile.

--status (string)

Project profile status.

Possible values:

ENABLED

DISABLED

--project-resource-tags (list)

The resource tags of the project profile.

(structure)

The resource tag parameter of the project profile.

key -> (string)

The key of the resource tag parameter of the project profile.

value -> (string)

The value of the resource tag parameter key of the project profile.

isValueEditable -> (boolean)

Specifies whether the value of the resource tag parameter of the project profile is editable at the project level.

Shorthand Syntax:

key=string,value=string,isValueEditable=boolean ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string",
    "isValueEditable": true|false
  }
  ...
]

--allow-custom-project-resource-tags | --no-allow-custom-project-resource-tags (boolean)

Specifies whether custom project resource tags are supported.

--project-resource-tags-description (string)

Field viewable through the UI that provides a project user with the allowed resource tag specifications.

--environment-configurations (list)

Environment configurations of the project profile.

(structure)

The configuration of an environment.

name -> (string)

The environment name.

id -> (string)

The environment ID.

environmentBlueprintId -> (string)

The environment blueprint ID.

description -> (string)

The environment description.

deploymentMode -> (string)

The deployment mode of the environment.

configurationParameters -> (structure)

The configuration parameters of the environment.

ssmPath -> (string)

Ssm path environment configuration parameters.

parameterOverrides -> (list)

The parameter overrides.

(structure)

The environment configuration parameter.

name -> (string)

The name of the environment configuration parameter.

value -> (string)

The value of the environment configuration parameter.

isEditable -> (boolean)

Specifies whether the environment parameter is editable.

resolvedParameters -> (list)

The resolved environment configuration parameters.

(structure)

The environment configuration parameter.

name -> (string)

The name of the environment configuration parameter.

value -> (string)

The value of the environment configuration parameter.

isEditable -> (boolean)

Specifies whether the environment parameter is editable.

awsAccount -> (tagged union structure)

The Amazon Web Services account of the environment.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsAccountId, awsAccountIdPath.

awsAccountId -> (string)

The account ID of a project.

awsAccountIdPath -> (string)

The account ID path of a project.

accountPools -> (list)

The account pools used by a custom project profile.

(string)

awsRegion -> (tagged union structure)

The Amazon Web Services Region of the environment.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: regionName, regionNamePath.

regionName -> (string)

The Amazon Web Services Region name.

regionNamePath -> (string)

The region name path.

deploymentOrder -> (integer)

The deployment order of the environment.

JSON Syntax:

[
  {
    "name": "string",
    "id": "string",
    "environmentBlueprintId": "string",
    "description": "string",
    "deploymentMode": "ON_CREATE"|"ON_DEMAND",
    "configurationParameters": {
      "ssmPath": "string",
      "parameterOverrides": [
        {
          "name": "string",
          "value": "string",
          "isEditable": true|false
        }
        ...
      ],
      "resolvedParameters": [
        {
          "name": "string",
          "value": "string",
          "isEditable": true|false
        }
        ...
      ]
    },
    "awsAccount": {
      "awsAccountId": "string",
      "awsAccountIdPath": "string"
    },
    "accountPools": ["string", ...],
    "awsRegion": {
      "regionName": "string",
      "regionNamePath": "string"
    },
    "deploymentOrder": integer
  }
  ...
]

--domain-unit-identifier (string)

A domain unit ID of the project profile.

--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 ID of the domain where a project profile is created.

id -> (string)

Project profile ID.

name -> (string)

Project profile name.

description -> (string)

A project profile description.

status -> (string)

Project profile status.

projectResourceTags -> (list)

The resource tags of the project profile.

(structure)

The resource tag parameter of the project profile.

key -> (string)

The key of the resource tag parameter of the project profile.

value -> (string)

The value of the resource tag parameter key of the project profile.

isValueEditable -> (boolean)

Specifies whether the value of the resource tag parameter of the project profile is editable at the project level.

allowCustomProjectResourceTags -> (boolean)

Specifies whether custom project resource tags are supported.

projectResourceTagsDescription -> (string)

Field viewable through the UI that provides a project user with the allowed resource tag specifications.

environmentConfigurations -> (list)

Environment configurations of a project profile.

(structure)

The configuration of an environment.

name -> (string)

The environment name.

id -> (string)

The environment ID.

environmentBlueprintId -> (string)

The environment blueprint ID.

description -> (string)

The environment description.

deploymentMode -> (string)

The deployment mode of the environment.

configurationParameters -> (structure)

The configuration parameters of the environment.

ssmPath -> (string)

Ssm path environment configuration parameters.

parameterOverrides -> (list)

The parameter overrides.

(structure)

The environment configuration parameter.

name -> (string)

The name of the environment configuration parameter.

value -> (string)

The value of the environment configuration parameter.

isEditable -> (boolean)

Specifies whether the environment parameter is editable.

resolvedParameters -> (list)

The resolved environment configuration parameters.

(structure)

The environment configuration parameter.

name -> (string)

The name of the environment configuration parameter.

value -> (string)

The value of the environment configuration parameter.

isEditable -> (boolean)

Specifies whether the environment parameter is editable.

awsAccount -> (tagged union structure)

The Amazon Web Services account of the environment.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsAccountId, awsAccountIdPath.

awsAccountId -> (string)

The account ID of a project.

awsAccountIdPath -> (string)

The account ID path of a project.

accountPools -> (list)

The account pools used by a custom project profile.

(string)

awsRegion -> (tagged union structure)

The Amazon Web Services Region of the environment.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: regionName, regionNamePath.

regionName -> (string)

The Amazon Web Services Region name.

regionNamePath -> (string)

The region name path.

deploymentOrder -> (integer)

The deployment order of the environment.

createdBy -> (string)

A user who created a project profile.

createdAt -> (timestamp)

A timestamp at which a project profile is created.

lastUpdatedAt -> (timestamp)

A timestamp when a project profile was last updated.

domainUnitId -> (string)

The ID of the domain unit where a project profile is created.

Table of Contents

Feedback

User Guide

Note:

create-project-profile¶

Description¶

Synopsis¶

Options¶

Note

Note

Global Options¶

Output¶

Note

Note