Skip to content

list_api_key_credential_providers

list_api_key_credential_providers(
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[MaxResults] = None,
) -> ListApiKeyCredentialProvidersResponse

Lists all API key credential providers in your account.

Parameters:

  • next_token (Optional[str], default: None ) –

    Pagination token.

  • max_results (Optional[MaxResults], default: None ) –

    Maximum number of results to return.

Raises:

  • AccessDeniedException –

    This exception is thrown when a request is denied per access permissions

  • InternalServerException –

    This exception is thrown if there was an unexpected error during processing of request

  • ResourceNotFoundException –

    This exception is thrown when a resource referenced by the operation does not exist

  • ThrottlingException –

    This exception is thrown when the number of requests exceeds the limit

  • UnauthorizedException –

    This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

  • ValidationException –

    The input fails to satisfy the constraints specified by the service.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def list_api_key_credential_providers(
    self,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[
        "capo_bedrock_agentcore_control.types.max_results.MaxResults"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.list_api_key_credential_providers_response.ListApiKeyCredentialProvidersResponse":
    """<p>Lists all API key credential providers in your account.</p>

    Args:
        next_token: <p>Pagination token.</p>
        max_results: <p>Maximum number of results to return.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.unauthorized_exception.UnauthorizedException: <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.list_api_key_credential_providers_request.ListApiKeyCredentialProvidersRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.list_api_key_credential_providers_response.ListApiKeyCredentialProvidersResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_api_key_credential_providers

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_api_key_credential_providers.list_api_key_credential_providers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApiKeyCredentialProviders")
    )
    input_: capo_bedrock_agentcore_control.types.list_api_key_credential_providers_request.ListApiKeyCredentialProvidersRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output