View a markdown version of this page

ConsentPortalSummary - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ConsentPortalSummary

Summary information about a consent portal.

Contents

consentPortalArn

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

Type: String

Pattern: arn:aws[^:]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:consent-portal/[a-zA-Z0-9\-_]{1,50}-[A-Za-z0-9]{10}

Required: Yes

consentPortalId

The unique identifier of the consent portal.

Type: String

Pattern: [a-zA-Z0-9\-_]{1,50}-[A-Za-z0-9]{10}

Required: Yes

createdAt

The timestamp for when the consent portal was created.

Type: Timestamp

Required: Yes

name

The name of the consent portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: [a-zA-Z0-9_-]{1,50}

Required: Yes

sources

The resources served by the consent portal.

Type: Array of ConsentPortalSource objects

Array Members: Fixed number of 1 item.

Required: Yes

status

The current status of the consent portal.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | UPDATE_FAILED | DELETING | FAILED

Required: Yes

updatedAt

The timestamp for when the consent portal was last updated.

Type: Timestamp

Required: Yes

description

The description of the consent portal.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Required: No

portalUrl

The URL used to access the consent portal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: