BedrockAgentCoreControl / Client / list_consent_portals

list_consent_portals

BedrockAgentCoreControl.Client.list_consent_portals(**kwargs)

Lists all of the consent portals in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_consent_portals(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of consent portals to return in a single call.

• nextToken (string) – A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.

Return type:

dict

Returns:

Response Syntax

{
    'consentPortals': [
        {
            'sources': [
                {
                    'identifier': 'string',
                    'type': 'agentcore-gateway'
                },
            ],
            'consentPortalArn': 'string',
            'consentPortalId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'name': 'string',
            'portalUrl': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • consentPortals (list) –

    The list of consent portals.

    • (dict) –

      Summary information about a consent portal.

      • sources (list) –

        The resources served by the consent portal.

        • (dict) –

          A resource served by the consent portal.

          • identifier (string) –

            The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).

          • type (string) –

            The type of the source resource.

      • consentPortalArn (string) –

        The Amazon Resource Name (ARN) of the consent portal.

      • consentPortalId (string) –

        The unique identifier of the consent portal.

      • createdAt (datetime) –

        The timestamp for when the consent portal was created.

      • description (string) –

        The description of the consent portal.

      • name (string) –

        The name of the consent portal.

      • portalUrl (string) –

        The URL used to access the consent portal.

      • status (string) –

        The current status of the consent portal.

      • updatedAt (datetime) –

        The timestamp for when the consent portal was last updated.

  • nextToken (string) –

    The token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.UnauthorizedException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException