Skip to content

Bedrock AgentCore Control  >  Operations  >  get_consent_portal

get_consent_portal

Operation

get_consent_portal(input: GetConsentPortalInput, plugins: list[Plugin] | None = None) -> GetConsentPortalOutput

Retrieves information about a consent portal.

Parameters:

Name Type Description Default
input GetConsentPortalInput

An instance of GetConsentPortalInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetConsentPortalOutput

An instance of GetConsentPortalOutput.

Input

GetConsentPortalInput dataclass

Dataclass for GetConsentPortalInput structure.

Attributes

consent_portal_identifier class-attribute instance-attribute 
consent_portal_identifier: str | None = None

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

Output

GetConsentPortalOutput dataclass

Dataclass for GetConsentPortalOutput structure.

Attributes

consent_portal_arn instance-attribute 
consent_portal_arn: str

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

consent_portal_id instance-attribute 
consent_portal_id: str

The unique identifier of the consent portal.

created_at instance-attribute 
created_at: datetime

The timestamp for when the consent portal was created.

description class-attribute instance-attribute 
description: str | None = None

The description of the consent portal.

execution_role_arn instance-attribute 
execution_role_arn: str

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

idp_config instance-attribute 
idp_config: ConsentPortalIdpConfig

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

name instance-attribute 
name: str

The name of the consent portal.

portal_url class-attribute instance-attribute 
portal_url: str | None = None

The URL used to access the consent portal.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

sources instance-attribute 
sources: list[ConsentPortalSource]

The resources served by the consent portal.

status instance-attribute 
status: str

The current status of the consent portal.

status_reason class-attribute instance-attribute 
status_reason: str | None = None

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

updated_at instance-attribute 
updated_at: datetime

The timestamp for when the consent portal was last updated.