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

Description¶

Creates an Amazon DataZone domain.

Synopsis¶

  create-domain
[--client-token <value>]
[--description <value>]
--domain-execution-role <value>
[--domain-version <value>]
[--kms-key-identifier <value>]
--name <value>
[--service-role <value>]
[--single-sign-on <value>]
[--tags <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¶

--client-token (string)

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

--description (string)

The description of the Amazon DataZone domain.

--domain-execution-role (string)

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

--domain-version (string)

The version of the domain that is created.

Possible values:

V1

V2

--kms-key-identifier (string)

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

--name (string)

The name of the Amazon DataZone domain.

--service-role (string)

The service role of the domain that is created.

--single-sign-on (structure)

The single-sign on configuration of the Amazon DataZone domain.

type -> (string)

The type of single sign-on in Amazon DataZone.

userAssignment -> (string)

The single sign-on user assignment in Amazon DataZone.

Shorthand Syntax:

type=string,userAssignment=string

JSON Syntax:

{
  "type": "IAM_IDC"|"DISABLED",
  "userAssignment": "AUTOMATIC"|"MANUAL"
}

--tags (map)

The tags specified for the Amazon DataZone domain.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

Output¶

arn -> (string)

The ARN of the Amazon DataZone domain.

description -> (string)

The description of the Amazon DataZone domain.

domainExecutionRole -> (string)

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon Web Services account that houses the Amazon DataZone domain.

domainVersion -> (string)

The version of the domain that is created.

id -> (string)

The identifier of the Amazon DataZone domain.

kmsKeyIdentifier -> (string)

The identifier of the Amazon Web Services Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

name -> (string)

The name of the Amazon DataZone domain.

portalUrl -> (string)

The URL of the data portal for this Amazon DataZone domain.

rootDomainUnitId -> (string)

The ID of the root domain unit.

serviceRole -> (string)

Te service role of the domain that is created.

singleSignOn -> (structure)

The single-sign on configuration of the Amazon DataZone domain.

type -> (string)

The type of single sign-on in Amazon DataZone.

userAssignment -> (string)

The single sign-on user assignment in Amazon DataZone.

status -> (string)

The status of the Amazon DataZone domain.

tags -> (map)