Skip to content

list_consent_portals

Operation

list_consent_portals(request: ListConsentPortalsInput | ListConsentPortalsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConsentPortalsInputDict]) -> ListConsentPortalsOutput

Lists all of the consent portals in your account.

Parameters:

Name Type Description Default
request ListConsentPortalsInput | ListConsentPortalsInputDict | 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[ListConsentPortalsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConsentPortalsOutput

An instance of ListConsentPortalsOutput.

list_consent_portals(request: ListConsentPortalsInput | ListConsentPortalsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListConsentPortalsInputDict]) -> ListConsentPortalsOutput

Lists all of the consent portals in your account.

Parameters:

Name Type Description Default
request ListConsentPortalsInput | ListConsentPortalsInputDict | 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[ListConsentPortalsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListConsentPortalsOutput

An instance of ListConsentPortalsOutput.

Input

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

ListConsentPortalsInputDict

Bases: TypedDict

Dictionary form of ListConsentPortalsInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of consent portals to return in a single call.

next_token instance-attribute
next_token: str | None

A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.

ListConsentPortalsInput dataclass

Bases: _SerdeShape

Dataclass for ListConsentPortalsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of consent portals to return in a single call.

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

A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.

Output

ListConsentPortalsOutput dataclass

Bases: _SerdeShape

Dataclass for ListConsentPortalsOutput structure.

Attributes

consent_portals instance-attribute
consent_portals: list[ConsentPortalSummary]

The list of consent portals.

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

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.

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.