Skip to content

get_consent_portal

Operation

get_consent_portal(request: GetConsentPortalInput | GetConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConsentPortalInputDict]) -> GetConsentPortalOutput

Retrieves information about a consent portal.

Parameters:

Name Type Description Default
request GetConsentPortalInput | GetConsentPortalInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetConsentPortalInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConsentPortalOutput

An instance of GetConsentPortalOutput.

get_consent_portal(request: GetConsentPortalInput | GetConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetConsentPortalInputDict]) -> GetConsentPortalOutput

Retrieves information about a consent portal.

Parameters:

Name Type Description Default
request GetConsentPortalInput | GetConsentPortalInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetConsentPortalInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetConsentPortalOutput

An instance of GetConsentPortalOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetConsentPortalInputDict

Bases: TypedDict

Dictionary form of GetConsentPortalInput.

Attributes

consent_portal_identifier instance-attribute
consent_portal_identifier: Required[str]

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

GetConsentPortalInput dataclass

Bases: _SerdeShape

Dataclass for GetConsentPortalInput structure.

Attributes

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

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

Output

GetConsentPortalOutput dataclass

Bases: _SerdeShape

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

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

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

The URL used to access the consent portal.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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

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

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.