create_consent_portal¶
Operation¶
create_consent_portal
¶
create_consent_portal(request: CreateConsentPortalInput | CreateConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateConsentPortalInputDict]) -> CreateConsentPortalOutput
Creates a new consent portal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateConsentPortalInput | CreateConsentPortalInputDict | 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[CreateConsentPortalInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateConsentPortalOutput
|
An instance of |
create_consent_portal
async
¶
create_consent_portal(request: CreateConsentPortalInput | CreateConsentPortalInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateConsentPortalInputDict]) -> CreateConsentPortalOutput
Creates a new consent portal.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateConsentPortalInput | CreateConsentPortalInputDict | 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[CreateConsentPortalInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateConsentPortalOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateConsentPortalInputDict
¶
Bases: TypedDict
Dictionary form of CreateConsentPortalInput.
Attributes¶
execution_role_arn
instance-attribute
¶
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
¶
idp_config: Required[ConsentPortalIdpConfig | ConsentPortalIdpConfigDict]
The identity provider configuration that the consent portal uses to authenticate end users.
name
instance-attribute
¶
The name of the consent portal. The name must be unique within your account.
sources
instance-attribute
¶
sources: Required[Sequence[ConsentPortalSource | ConsentPortalSourceDict]]
The resources served by the consent portal. Currently, we only support
type agentcore-gateway.
CreateConsentPortalInput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateConsentPortalInput structure.
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description of the consent portal.
execution_role_arn
class-attribute
instance-attribute
¶
execution_role_arn: str | None = ...
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
idp_config
class-attribute
instance-attribute
¶
idp_config: ConsentPortalIdpConfig | None = ...
The identity provider configuration that the consent portal uses to authenticate end users.
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the consent portal. The name must be unique within your account.
sources
class-attribute
instance-attribute
¶
sources: list[ConsentPortalSource] | None = ...
The resources served by the consent portal. Currently, we only support
type agentcore-gateway.
Output¶
CreateConsentPortalOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateConsentPortalOutput 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
¶
idp_config: ConsentPortalIdpConfig
The identity provider configuration that the consent portal uses to authenticate end users.
portal_url
class-attribute
instance-attribute
¶
portal_url: str | None = ...
The URL used to access the consent portal.
response_metadata
class-attribute
instance-attribute
¶
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
¶
sources: list[ConsentPortalSource]
The resources served by the consent portal.