Skip to content

create_domain

Operation

create_domain

create_domain(request: CreateDomainInput | CreateDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDomainInputDict]) -> CreateDomainOutput

Creates a new Domain for managing HealthAgent resources.

Parameters:

Name Type Description Default
request CreateDomainInput | CreateDomainInputDict | 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[CreateDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDomainOutput

An instance of CreateDomainOutput.

create_domain async

create_domain(request: CreateDomainInput | CreateDomainInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDomainInputDict]) -> CreateDomainOutput

Creates a new Domain for managing HealthAgent resources.

Parameters:

Name Type Description Default
request CreateDomainInput | CreateDomainInputDict | 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[CreateDomainInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateDomainOutput

An instance of CreateDomainOutput.

Input

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

CreateDomainInputDict

Bases: TypedDict

Dictionary form of CreateDomainInput.

Attributes

kms_key_arn instance-attribute
kms_key_arn: str | None

The ARN of the KMS key to use for encrypting data in this Domain.

name instance-attribute
name: Required[str]

The name for the new Domain.

tags instance-attribute
tags: Mapping[str, str] | None

Tags to associate with the Domain.

web_app_setup_configuration instance-attribute
web_app_setup_configuration: CreateWebAppConfiguration | CreateWebAppConfigurationDict | None

Configuration for the Domain web application. Optional, but if provided all fields are required.

CreateDomainInput dataclass

Bases: _SerdeShape

Dataclass for CreateDomainInput structure.

Attributes

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

The ARN of the KMS key to use for encrypting data in this Domain.

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

The name for the new Domain.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

Tags to associate with the Domain.

web_app_setup_configuration class-attribute instance-attribute
web_app_setup_configuration: CreateWebAppConfiguration | None = ...

Configuration for the Domain web application. Optional, but if provided all fields are required.

Output

CreateDomainOutput dataclass

Bases: _SerdeShape

Dataclass for CreateDomainOutput structure.

Attributes

arn instance-attribute
arn: str
created_at instance-attribute
created_at: datetime
domain_id instance-attribute
domain_id: str
encryption_context class-attribute instance-attribute
encryption_context: EncryptionContext | None = ...
kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = ...
name instance-attribute
name: str
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.

status instance-attribute
status: str
web_app_configuration class-attribute instance-attribute
web_app_configuration: WebAppConfiguration | None = ...
web_app_url class-attribute instance-attribute
web_app_url: str | None = ...