Skip to content

create_subscription

Operation

create_subscription

create_subscription(request: CreateSubscriptionInput | CreateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSubscriptionInputDict]) -> CreateSubscriptionOutput

Creates a new Subscription within a Domain for billing and user management.

Parameters:

Name Type Description Default
request CreateSubscriptionInput | CreateSubscriptionInputDict | 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[CreateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSubscriptionOutput

An instance of CreateSubscriptionOutput.

create_subscription async

create_subscription(request: CreateSubscriptionInput | CreateSubscriptionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateSubscriptionInputDict]) -> CreateSubscriptionOutput

Creates a new Subscription within a Domain for billing and user management.

Parameters:

Name Type Description Default
request CreateSubscriptionInput | CreateSubscriptionInputDict | 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[CreateSubscriptionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateSubscriptionOutput

An instance of CreateSubscriptionOutput.

Input

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

CreateSubscriptionInputDict

Bases: TypedDict

Dictionary form of CreateSubscriptionInput.

Attributes

domain_id instance-attribute
domain_id: Required[str]

The unique identifier of the parent Domain.

CreateSubscriptionInput dataclass

Bases: _SerdeShape

Dataclass for CreateSubscriptionInput structure.

Attributes

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

The unique identifier of the parent Domain.

Output

CreateSubscriptionOutput dataclass

Bases: _SerdeShape

Dataclass for CreateSubscriptionOutput structure.

Attributes

activated_at class-attribute instance-attribute
activated_at: datetime | None = ...
arn instance-attribute
arn: str
created_at instance-attribute
created_at: datetime
deactivated_at class-attribute instance-attribute
deactivated_at: datetime | None = ...
domain_id instance-attribute
domain_id: str
last_updated_at instance-attribute
last_updated_at: datetime
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
subscription_id instance-attribute
subscription_id: str