BedrockAgentCoreControl / Client / get_consent_portal

get_consent_portal

BedrockAgentCoreControl.Client.get_consent_portal(**kwargs)

Retrieves information about a consent portal.

See also: AWS API Documentation

Request Syntax

response = client.get_consent_portal(
    consentPortalIdentifier='string'
)

Parameters:

consentPortalIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • 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.

  • executionRoleArn (string) –

    The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.

  • idpConfig (dict) –

    The identity provider configuration that the consent portal uses to authenticate end users.

    • credentialProviderArn (string) –

      The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.

    • scopes (list) –

      The OAuth2 scopes that the consent portal requests when authenticating end users.

      • (string) –

    • audience (string) –

      The audience value that the consent portal includes when requesting tokens from the identity provider.

  • 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.

  • statusReason (string) –

    A message that provides additional information about the current status of the consent portal.

  • updatedAt (datetime) –

    The timestamp for when the consent portal was last updated.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.UnauthorizedException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException