Class CreateSpaceRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateSpaceRequest.Builder,CreateSpaceRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic CreateSpaceRequest.Builderbuilder()final StringA unique, case-sensitive identifier that makes the request idempotent.final EncryptionConfigurationThe AWS KMS key that encrypts the space's data.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IntegerHow many days the space keeps each event, from 1 to 365.final StringThe model that extracts and consolidates memories for every strategy in the space, as an Amazon Bedrock model ID without an inference-profile prefix:anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the MemoryStrategies property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final IntegerHow many days the space keeps each memory, from 0 to 3650, counted from when the service writes the memory.final List<MemoryStrategy> The memory strategies that extract memories from the space's events: up to 10 strategies, each with a name that is unique within the space.final Stringname()A name for the space, unique within your account in the Region.static Class<? extends CreateSpaceRequest.Builder> tags()The tags to add to the space.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A name for the space, unique within your account in the Region. If another space already has the name, the request fails with
ConflictException.- Returns:
- A name for the space, unique within your account in the Region. If another space already has the name,
the request fails with
ConflictException.
-
hasMemoryStrategies
public final boolean hasMemoryStrategies()For responses, this returns true if the service returned a value for the MemoryStrategies property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
memoryStrategies
The memory strategies that extract memories from the space's events: up to 10 strategies, each with a name that is unique within the space.
Optional. Omit it, or send an empty list, to create a space with no memory strategies. Such a space stores the conversation events you send it and returns them through
SearchEventsandListEvents, but extracts no memories and has none to search. You can add strategies later withUpdateSpace.The serialized list can be at most 384 KiB.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMemoryStrategies()method.- Returns:
- The memory strategies that extract memories from the space's events: up to 10 strategies, each with a
name that is unique within the space.
Optional. Omit it, or send an empty list, to create a space with no memory strategies. Such a space stores the conversation events you send it and returns them through
SearchEventsandListEvents, but extracts no memories and has none to search. You can add strategies later withUpdateSpace.The serialized list can be at most 384 KiB.
-
eventExpiryDays
How many days the space keeps each event, from 1 to 365. The default is 90.
- Returns:
- How many days the space keeps each event, from 1 to 365. The default is 90.
-
memoryExpiryDays
How many days the space keeps each memory, from 0 to 3650, counted from when the service writes the memory. Updating a memory with
UpdateMemorydoesn't restart the count. 0 means memories never expire. If you omit it, memories never expire.Searches and lists leave out a memory past its expiry, and reading, updating, or deleting it returns
ResourceNotFoundException.- Returns:
- How many days the space keeps each memory, from 0 to 3650, counted from when the service writes the
memory. Updating a memory with
UpdateMemorydoesn't restart the count. 0 means memories never expire. If you omit it, memories never expire.Searches and lists leave out a memory past its expiry, and reading, updating, or deleting it returns
ResourceNotFoundException.
-
extractionModelId
The model that extracts and consolidates memories for every strategy in the space, as an Amazon Bedrock model ID without an inference-profile prefix:
anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5. Another value fails withValidationException, and the message lists the supported IDs. Omit it to use the service default, which can change over time and isn't returned byGetSpace. Setting a value pins the model.- Returns:
- The model that extracts and consolidates memories for every strategy in the space, as an Amazon Bedrock
model ID without an inference-profile prefix:
anthropic.claude-opus-5-5oranthropic.claude-haiku-5-5. Another value fails withValidationException, and the message lists the supported IDs. Omit it to use the service default, which can change over time and isn't returned byGetSpace. Setting a value pins the model.
-
encryptionConfiguration
The AWS KMS key that encrypts the space's data. Omit it, or omit its
kmsKeyArn, to use an AWS owned key. You can't change the key after you create the space.- Returns:
- The AWS KMS key that encrypts the space's data. Omit it, or omit its
kmsKeyArn, to use an AWS owned key. You can't change the key after you create the space.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The tags to add to the space.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- The tags to add to the space.
-
clientToken
A unique, case-sensitive identifier that makes the request idempotent. A retry with the same token and the same parameters within 2 hours returns the space that the first request created, instead of creating another. Reusing the token with different parameters, or while the first request is still in progress, fails with
ConflictException.- Returns:
- A unique, case-sensitive identifier that makes the request idempotent. A retry with the same token and
the same parameters within 2 hours returns the space that the first request created, instead of creating
another. Reusing the token with different parameters, or while the first request is still in progress,
fails with
ConflictException.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateSpaceRequest.Builder,CreateSpaceRequest> - Specified by:
toBuilderin classOpenSearchMemoryRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-