Skip to content

delete_consent_portal

Operation

delete_consent_portal(request: DeleteConsentPortalInput | DeleteConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteConsentPortalInputDict]) -> DeleteConsentPortalOutput

Deletes a consent portal.

Parameters:

Name Type Description Default
request DeleteConsentPortalInput | DeleteConsentPortalInputDict | 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[DeleteConsentPortalInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteConsentPortalOutput

An instance of DeleteConsentPortalOutput.

delete_consent_portal(request: DeleteConsentPortalInput | DeleteConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteConsentPortalInputDict]) -> DeleteConsentPortalOutput

Deletes a consent portal.

Parameters:

Name Type Description Default
request DeleteConsentPortalInput | DeleteConsentPortalInputDict | 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[DeleteConsentPortalInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteConsentPortalOutput

An instance of DeleteConsentPortalOutput.

Input

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

DeleteConsentPortalInputDict

Bases: TypedDict

Dictionary form of DeleteConsentPortalInput.

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

DeleteConsentPortalInput dataclass

Bases: _SerdeShape

Dataclass for DeleteConsentPortalInput 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

DeleteConsentPortalOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteConsentPortalOutput structure.

Attributes

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.