create_retrieval_instruction¶
Operation¶
create_retrieval_instruction
¶
create_retrieval_instruction(request: CreateRetrievalInstructionInput | CreateRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRetrievalInstructionInputDict]) -> CreateRetrievalInstructionOutput
Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRetrievalInstructionInput | CreateRetrievalInstructionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateRetrievalInstructionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRetrievalInstructionOutput
|
An instance of |
create_retrieval_instruction
async
¶
create_retrieval_instruction(request: CreateRetrievalInstructionInput | CreateRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRetrievalInstructionInputDict]) -> CreateRetrievalInstructionOutput
Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRetrievalInstructionInput | CreateRetrievalInstructionInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CreateRetrievalInstructionInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRetrievalInstructionOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateRetrievalInstructionInputDict
¶
Bases: TypedDict
Dictionary form of CreateRetrievalInstructionInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.
This field is autopopulated if not provided.
customer_encryption_key_arn
instance-attribute
¶
customer_encryption_key_arn: str | None
The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.
description
instance-attribute
¶
description: str | None
Specifies a description of the retrieval instruction.
instruction
instance-attribute
¶
instruction: Required[RetrievalInstructionContent | RetrievalInstructionContentDict]
The instruction content, as a set of named fields. Get does not return this field until the create review passes.
CreateRetrievalInstructionInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRetrievalInstructionInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A caller-supplied token that makes a retried create return the existing resource rather than a second one. The window is 8 hours.
This field is autopopulated if not provided.
customer_encryption_key_arn
class-attribute
instance-attribute
¶
customer_encryption_key_arn: str | None = ...
The Amazon Resource Name (ARN) of a customer managed AWS Key Management Service (AWS KMS) key used to encrypt the instruction content at rest. If you omit it, the service uses an AWS owned key. You fix the key at create and cannot change it later.
description
class-attribute
instance-attribute
¶
description: str | None = ...
Specifies a description of the retrieval instruction.
instruction
class-attribute
instance-attribute
¶
instruction: RetrievalInstructionContent | None = ...
The instruction content, as a set of named fields. Get does not return this field until the create review passes.
Output¶
CreateRetrievalInstructionOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateRetrievalInstructionOutput structure.
Attributes¶
last_transition_status
instance-attribute
¶
last_transition_status: str
Always CREATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
retrieval_instruction_arn
instance-attribute
¶
retrieval_instruction_arn: str
The ARN of the newly created retrieval instruction.
retrieval_instruction_id
instance-attribute
¶
retrieval_instruction_id: str
The identifier of the newly created retrieval instruction.