Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.
Parameters:
-
memory_id
(MemoryId)
–
The unique identifier of the memory to list extraction jobs for.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of results to return in a single call. The default value is 20.
-
filter
(Optional[ExtractionJobFilterInput], default:
None
)
–
Filter criteria to apply when listing extraction jobs.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Raises:
-
AccessDeniedException
–
The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.
-
ResourceNotFoundException
–
The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.
-
ServiceException
–
The service encountered an internal error. Try your request again later.
-
ServiceQuotaExceededException
–
The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.
-
ThrottledException
–
The request was denied due to request throttling. Reduce the frequency of requests and try again.
-
ValidationException
–
The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_bedrock_agentcore/_services/bedrock_agent_core.py
| def list_memory_extraction_jobs(
self,
memory_id: "capo_bedrock_agentcore.types.memory_id.MemoryId",
*,
config_overrides: Optional[BedrockAgentCoreClientConfig] = None,
max_results: Optional[int] = None,
filter: Optional[
"capo_bedrock_agentcore.types.extraction_job_filter_input.ExtractionJobFilterInput"
] = None,
next_token: Optional[
"capo_bedrock_agentcore.types.pagination_token.PaginationToken"
] = None,
) -> "capo_bedrock_agentcore.types.list_memory_extraction_jobs_output.ListMemoryExtractionJobsOutput":
"""<p>Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.</p> <p>To use this operation, you must have the <code>bedrock-agentcore:ListMemoryExtractionJobs</code> permission.</p>
Args:
memory_id: <p>The unique identifier of the memory to list extraction jobs for.</p>
max_results: <p>The maximum number of results to return in a single call. The default value is 20.</p>
filter: <p>Filter criteria to apply when listing extraction jobs.</p>
next_token: <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
Raises:
capo_bedrock_agentcore.errors.access_denied_exception.AccessDeniedException: <p>The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.</p>
capo_bedrock_agentcore.errors.resource_not_found_exception.ResourceNotFoundException: <p>The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.</p>
capo_bedrock_agentcore.errors.service_exception.ServiceException: <p>The service encountered an internal error. Try your request again later.</p>
capo_bedrock_agentcore.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.</p>
capo_bedrock_agentcore.errors.throttled_exception.ThrottledException: <p>The request was denied due to request throttling. Reduce the frequency of requests and try again.</p>
capo_bedrock_agentcore.errors.validation_exception.ValidationException: <p>The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.</p>
capo_bedrock_agentcore.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_bedrock_agentcore.types.list_memory_extraction_jobs_input.ListMemoryExtractionJobsInput]",
) -> OperationResponse[
"capo_bedrock_agentcore.types.list_memory_extraction_jobs_output.ListMemoryExtractionJobsOutput"
]:
import capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.list_memory_extraction_jobs
output, http_response = (
capo_bedrock_agentcore._operations.amazon_bedrock_agent_core.list_memory_extraction_jobs.list_memory_extraction_jobs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListMemoryExtractionJobs")
)
input_: capo_bedrock_agentcore.types.list_memory_extraction_jobs_input.ListMemoryExtractionJobsInput = {
"memory_id": memory_id
}
if max_results is not None:
input_["max_results"] = max_results
if filter is not None:
input_["filter"] = filter
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|