Skip to content

list_agent_contexts async

list_agent_contexts(
    profile_arn: AgentProfileArn,
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListAgentContextsResponse

Lists contexts associated with a profile.

Parameters:

  • profile_arn (AgentProfileArn) –

    The Amazon Resource Name (ARN) of the profile to list contexts for.

Raises:

Source code in docs_src/capo_wellarchitected/_services/async_well_architected.py
async def list_agent_contexts(
    self,
    profile_arn: "capo_wellarchitected.types.agent_profile_arn.AgentProfileArn",
    *,
    config_overrides: Optional[AsyncWellArchitectedClientConfig] = None,
    max_results: Optional[
        "capo_wellarchitected.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_wellarchitected.types.next_token.NextToken"] = None,
) -> "capo_wellarchitected.types.list_agent_contexts_response.ListAgentContextsResponse":
    """<p>Lists contexts associated with a profile.</p>

    Args:
        profile_arn: <p>The Amazon Resource Name (ARN) of the profile to list contexts for.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wellarchitected.types.list_agent_contexts_request.ListAgentContextsRequest]",
    ) -> AsyncOperationResponse[
        "capo_wellarchitected.types.list_agent_contexts_response.ListAgentContextsResponse"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.list_agent_contexts

        (
            output,
            http_response,
        ) = await capo_wellarchitected._operations.well_architected_api_service_lambda.list_agent_contexts.async_list_agent_contexts(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_wellarchitected.types.list_agent_contexts_response.ListAgentContextsResponse",
    ) -> dict[str, Any]:
        import capo_wellarchitected.types.list_agent_contexts_response

        return capo_wellarchitected.types.list_agent_contexts_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListAgentContexts", redact_output=_redact_output),
    )
    input_: capo_wellarchitected.types.list_agent_contexts_request.ListAgentContextsRequest = {
        "profile_arn": profile_arn
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output