Skip to content

Bedrock AgentCore Control  >  Operations  >  delete_consent_portal

delete_consent_portal

Operation

delete_consent_portal(input: DeleteConsentPortalInput, plugins: list[Plugin] | None = None) -> DeleteConsentPortalOutput

Deletes a consent portal.

Parameters:

Name Type Description Default
input DeleteConsentPortalInput

An instance of DeleteConsentPortalInput.

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
DeleteConsentPortalOutput

An instance of DeleteConsentPortalOutput.

Input

DeleteConsentPortalInput dataclass

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

DeleteConsentPortalOutput dataclass

Dataclass for DeleteConsentPortalOutput structure.

Attributes

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.