get_consent_portal ¶

get_consent_portal(
    consent_portal_identifier: ConsentPortalIdentifier,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
) -> GetConsentPortalResponse

Retrieves information about a consent portal.

Parameters:

consent_portal_identifier (ConsentPortalIdentifier) –

The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).

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 get_consent_portal(
    self,
    consent_portal_identifier: "capo_bedrock_agentcore_control.types.consent_portal_identifier.ConsentPortalIdentifier",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
) -> "capo_bedrock_agentcore_control.types.get_consent_portal_response.GetConsentPortalResponse":
    """<p>Retrieves information about a consent portal.</p>

    Args:
        consent_portal_identifier: <p>The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).</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.get_consent_portal_request.GetConsentPortalRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.get_consent_portal_response.GetConsentPortalResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.get_consent_portal

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetConsentPortal")
    )
    input_: capo_bedrock_agentcore_control.types.get_consent_portal_request.GetConsentPortalRequest = {
        "consent_portal_identifier": consent_portal_identifier
    }

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