RetrievalInstructionSummary
A summary of a retrieval instruction, without the content.
Contents
- createdAt
-
When you created the retrieval instruction.
Type: Timestamp
Required: Yes
- lastTransitionStatus
-
The outcome or in-progress state of the most recent create or update of the retrieval instruction.
Type: String
Valid Values:
CREATING | UPDATING | CREATE_SUCCESSFUL | CREATE_FAILED | UPDATE_SUCCESSFUL | UPDATE_FAILEDRequired: Yes
- name
-
The name of the retrieval instruction.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
([0-9a-zA-Z][_-]?){1,100}Required: Yes
- retrievalInstructionArn
-
The ARN of the retrieval instruction.
Type: String
Pattern:
arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:retrieval-instruction/[a-z0-9]{10}Required: Yes
- retrievalInstructionId
-
The identifier of the retrieval instruction.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
[a-z0-9]{10}Required: Yes
- status
-
Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.
Type: String
Valid Values:
ACTIVE | INACTIVERequired: Yes
- updatedAt
-
When the retrieval instruction was last updated.
Type: Timestamp
Required: Yes
- description
-
A description of the retrieval instruction.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
