View a markdown version of this page

GetSpace - Amazon OpenSearch Memory

GetSpace

Returns a space's configuration and status.

Request Syntax

{ "spaceId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

spaceId

The ID of the space.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: sp-[a-f0-9]{12}

Required: Yes

Response Syntax

{ "arn": "string", "createdAt": number, "encryptionConfiguration": { "kmsKeyArn": "string" }, "eventExpiryDays": number, "extractionModelId": "string", "memoryExpiryDays": number, "memoryStrategies": [ { "configuration": { "consolidationEnabled": boolean, "extractEveryNMessages": number, "extractEveryNTokens": number, "extractionPrompt": "string", "extractionSeedRecentN": number, "extractionSeedTopK": number, "idleTimeoutSeconds": number }, "description": "string", "name": "string", "type": "string" } ], "name": "string", "spaceId": "string", "status": "string", "statusReason": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The Amazon Resource Name (ARN) of the space.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: arn:aws:osm:[a-z0-9-]+:[0-9]{12}:space/sp-[a-f0-9]{12}

createdAt

When the space was created.

Type: Timestamp

encryptionConfiguration

The AWS KMS key the space was created with. Absent when the space uses an AWS owned key.

Type: EncryptionConfiguration object

eventExpiryDays

How many days the space keeps each event. Absent when it was never set, in which case the default of 90 days applies.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 365.

extractionModelId

The model that extracts and consolidates memories for the space. Absent when it was never set. The service default then applies, which is currently anthropic.claude-haiku-5-5.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9][a-zA-Z0-9._:-]*

memoryExpiryDays

How many days the space keeps each memory. 0 means memories never expire. Absent when it was never set, in which case memories never expire.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 3650.

memoryStrategies

The space's memory strategies, including the names the service generated for strategies created without one. Empty for a space that has no memory strategies.

Type: Array of MemoryStrategy objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

name

The name of the space.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z][a-zA-Z0-9 _-]*

spaceId

The ID of the space.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: sp-[a-f0-9]{12}

status

The status of the space.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | DELETED | FAILED

statusReason

Details about why the space is FAILED. Read it only when status is FAILED: it can still hold the reason for an earlier failure.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this operation. To use this operation, you must have AWS Identity and Access Management (IAM) permissions for the operation, and on the resource it acts on. If the space uses a customer managed AWS Key Management Service (AWS KMS) key, you must also have permission to use the key.

message

A message that describes which access the request is missing.

HTTP Status Code: 403

InternalServerException

The service couldn't process the request because of an internal error. Retry the request.

message

A message that describes the internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist. Check the IDs in the request.

message

A message that describes which resource wasn't found.

resourceId

The ID of the resource that wasn't found.

resourceType

The type of the resource that wasn't found.

HTTP Status Code: 404

ThrottlingException

The service throttled the request. Retry the request with exponential backoff.

message

A message that describes the throttling.

retryAfterSeconds

The number of seconds to wait before you retry the request.

HTTP Status Code: 429

ValidationException

The request isn't valid. The reason, message, and fieldList members describe the problem. Fix the request, and then try again.

fieldList

The fields that failed validation, if any.

message

A message that describes why the request failed validation, such as the field, key, or limit involved.

reason

The reason that the request failed validation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: