list_consent_portals ¶

list_consent_portals(
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> ListConsentPortalsResponse

Lists all of the consent portals in your account.

Parameters:

max_results (Optional[int], default: None ) –

The maximum number of consent portals to return in a single call.
next_token (Optional[str], default: None ) –

A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.

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
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_consent_portals(
    self,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
) -> "capo_bedrock_agentcore_control.types.list_consent_portals_response.ListConsentPortalsResponse":
    """<p>Lists all of the consent portals in your account.</p>

    Args:
        max_results: <p>The maximum number of consent portals to return in a single call.</p>
        next_token: <p>A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.</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.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_consent_portals_request.ListConsentPortalsRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.list_consent_portals_response.ListConsentPortalsResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.list_consent_portals

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConsentPortals")
    )
    input_: capo_bedrock_agentcore_control.types.list_consent_portals_request.ListConsentPortalsRequest = {}
    if max_results is not None:
        input_["max_results"] = max_results
    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