AgentsforBedrock / Client / list_retrieval_instructions

list_retrieval_instructions

AgentsforBedrock.Client.list_retrieval_instructions(**kwargs)

Lists the retrieval instructions in the caller’s account. Results are paginated. Use the nextToken parameter to retrieve additional results.

See also: AWS API Documentation

Request Syntax

response = client.list_retrieval_instructions(
    status='ACTIVE'|'INACTIVE',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • status (string) – Return only instructions with this availability status.

  • maxResults (integer) – The maximum number of results to return in a single page. The effective upper bound is enforced service-side.

  • nextToken (string) – The pagination token from a previous ListRetrievalInstructions response.

Return type:

dict

Returns:

Response Syntax

{
    'retrievalInstructionSummaries': [
        {
            'retrievalInstructionId': 'string',
            'retrievalInstructionArn': 'string',
            'name': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'lastTransitionStatus': 'CREATING'|'UPDATING'|'CREATE_SUCCESSFUL'|'CREATE_FAILED'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'description': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • retrievalInstructionSummaries (list) –

      The retrieval instruction summaries in this page.

      • (dict) –

        A summary of a retrieval instruction, without the content.

        • retrievalInstructionId (string) –

          The identifier of the retrieval instruction.

        • retrievalInstructionArn (string) –

          The ARN of the retrieval instruction.

        • name (string) –

          The name of the retrieval instruction.

        • status (string) –

          Whether the instruction can be used. Only ACTIVE is resolvable at retrieval time.

        • lastTransitionStatus (string) –

          The outcome or in-progress state of the most recent create or update of the retrieval instruction.

        • createdAt (datetime) –

          When you created the retrieval instruction.

        • updatedAt (datetime) –

          When the retrieval instruction was last updated.

        • description (string) –

          A description of the retrieval instruction.

    • nextToken (string) –

      The pagination token to pass to the next ListRetrievalInstructions call, absent on the last page.

Exceptions