create-space¶

Description¶

Creates a space in a domain.

Use GetSpace to retrieve the space, ListSpaces to enumerate spaces, UpdateSpace to modify it, and DeleteSpace to remove it.

Synopsis¶

  create-space
--name <value>
--domain-id <value>
--data-access-role-arn <value>
[--agent-core-evaluation-role-arn <value>]
[--encryption-configuration <value>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--name (string) [required]

A name that identifies the space. Must be 3-64 characters: lowercase letters, numbers, and hyphens. It must begin and end with a letter or number and cannot contain consecutive hyphens.

Constraints:

min: 3

max: 64

pattern: [a-z0-9]+(-[a-z0-9]+)*

--domain-id (string) [required]

The ID of the domain to create the space in.

Constraints:

pattern: d-[0-9a-z]{1,25}

--data-access-role-arn (string) [required]

The ARN of the IAM role used for data access. The role must be in the caller’s account.

Constraints:

min: 1

max: 2048

pattern: arn:.+

--agent-core-evaluation-role-arn (string)

The ARN of the IAM role used by AgentCore online evaluation. Must be in the caller’s account. Omit if the space does not use AgentCore online evaluation.

Constraints:

min: 1

max: 2048

pattern: arn:.+

--encryption-configuration (structure)

How to encrypt the space’s data at rest. Omit for service owned encryption, which is equivalent to passing encryptionStrategy AWS_OWNED.

encryptionStrategy -> (string) [required]

Which kind of key to use. Required.

Possible values:

AWS_OWNED

CUSTOMER_MANAGED

kmsKeyArn -> (string)

Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller’s account and region.

Constraints:

pattern: arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/(mrk-)?[a-f0-9-]+

Shorthand Syntax:

encryptionStrategy=string,kmsKeyArn=string

JSON Syntax:

{
  "encryptionStrategy": "AWS_OWNED"|"CUSTOMER_MANAGED",
  "kmsKeyArn": "string"
}

--tags (map)

The tags to associate with the space.

Constraints:

min: 0

max: 50

key -> (string)

Tag key. Must be non-empty; AWS-standard maximum length. Constraining the key (rather than a bare String) rejects empty-key payloads at the edge with a 400 ValidationException instead of faulting downstream as a 500.

Constraints:

min: 1

max: 128

value -> (string)

Tag value. AWS-standard maximum length; may be empty.

Constraints:

min: 0

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--client-token (string)

Idempotency token for safe retries. Repeated requests with the same token return the original result instead of creating a duplicate.

Constraints:

min: 1

max: 64

pattern: [!-~]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

space -> (structure)

The details of the created space.

spaceId -> (string) [required]

The unique ID of the space.

Constraints:

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

name -> (string) [required]

A name that identifies the space.

spaceArn -> (string) [required]

The Amazon Resource Name (ARN) of the space.

Constraints:

min: 1

max: 2048

pattern: arn:.+

domainArn -> (string)

The Amazon Resource Name (ARN) of the domain the space belongs to. Absent when the space is not associated with a domain, so callers must tolerate its absence.

Constraints:

min: 1

max: 2048

pattern: arn:.+

region -> (string) [required]

The region where this space was created.

ownerAccountId -> (string) [required]

AWS account ID that owns this space.

Constraints:

min: 12

max: 12

pattern: [0-9]{12}

dataAccessRoleArn -> (string) [required]

The ARN of the IAM role used for data access.

Constraints:

min: 1

max: 2048

pattern: arn:.+

createdAt -> (timestamp) [required]

The timestamp when the space was created.

updatedAt -> (timestamp) [required]

The timestamp when the space was last updated.

agentCoreEvaluationRoleArn -> (string)

The ARN of the IAM role used by AgentCore online evaluation. Absent when the space was created without one.

Constraints:

min: 1

max: 2048

pattern: arn:.+

status -> (string) [required]

The status of the space.

Possible values:

ACTIVE

SUSPENDED

MOVING

statusReason -> (string)

Reason for the current space status.

encryptionConfiguration -> (structure)

How the space’s data at rest is encrypted. Always populated: a space with no customer managed key reports encryptionStrategy AWS_OWNED and no kmsKeyArn .

encryptionStrategy -> (string) [required]

Which kind of key to use. Required.

Possible values:

AWS_OWNED

CUSTOMER_MANAGED

kmsKeyArn -> (string)

Customer managed KMS key ARN. Required when encryptionStrategy is CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric ENCRYPT_DECRYPT key in the caller’s account and region.

Constraints:

pattern: arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/(mrk-)?[a-f0-9-]+

Table of Contents

Feedback

User Guide