create_deployment¶
Operation¶
create_deployment
¶
create_deployment(request: CreateDeploymentInput | CreateDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDeploymentInputDict]) -> CreateDeploymentOutput
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateDeploymentInput | CreateDeploymentInputDict | 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[CreateDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateDeploymentOutput
|
An instance of |
create_deployment
async
¶
create_deployment(request: CreateDeploymentInput | CreateDeploymentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDeploymentInputDict]) -> CreateDeploymentOutput
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateDeploymentInput | CreateDeploymentInputDict | 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[CreateDeploymentInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateDeploymentOutput
|
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.
CreateDeploymentInputDict
¶
Bases: TypedDict
Dictionary form of CreateDeploymentInput.
Attributes¶
cache_cluster_enabled
instance-attribute
¶
cache_cluster_enabled: bool | None
Enables a cache cluster for the Stage resource specified in the input.
cache_cluster_size
instance-attribute
¶
cache_cluster_size: str | None
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canary_settings
instance-attribute
¶
canary_settings: DeploymentCanarySettings | DeploymentCanarySettingsDict | None
The input configuration for the canary deployment when the deployment is a canary release deployment.
description
instance-attribute
¶
description: str | None
The description for the Deployment resource to create.
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
stage_description
instance-attribute
¶
stage_description: str | None
The description of the Stage resource for the Deployment resource to create.
stage_name
instance-attribute
¶
stage_name: str | None
The name of the Stage resource for the Deployment resource to create.
CreateDeploymentInput
dataclass
¶
Bases: _SerdeShape
Requests API Gateway to create a Deployment resource.
Attributes¶
cache_cluster_enabled
class-attribute
instance-attribute
¶
cache_cluster_enabled: bool | None = ...
Enables a cache cluster for the Stage resource specified in the input.
cache_cluster_size
class-attribute
instance-attribute
¶
cache_cluster_size: str | None = ...
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
canary_settings
class-attribute
instance-attribute
¶
canary_settings: DeploymentCanarySettings | None = ...
The input configuration for the canary deployment when the deployment is a canary release deployment.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description for the Deployment resource to create.
rest_api_id
class-attribute
instance-attribute
¶
rest_api_id: str | None = ...
The string identifier of the associated RestApi.
stage_description
class-attribute
instance-attribute
¶
stage_description: str | None = ...
The description of the Stage resource for the Deployment resource to create.
stage_name
class-attribute
instance-attribute
¶
stage_name: str | None = ...
The name of the Stage resource for the Deployment resource to create.
tracing_enabled
class-attribute
instance-attribute
¶
tracing_enabled: bool | None = ...
Specifies whether active tracing with X-ray is enabled for the Stage.
variables
class-attribute
instance-attribute
¶
A map that defines the stage variables for the Stage resource that is
associated with the new deployment. Variable names can have alphanumeric
and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+.
Output¶
CreateDeploymentOutput
dataclass
¶
Bases: _SerdeShape
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Attributes¶
api_summary
class-attribute
instance-attribute
¶
api_summary: dict[str, dict[str, MethodSnapshot]] | None = ...
A summary of the RestApi at the date and time that the deployment resource was created.
created_date
class-attribute
instance-attribute
¶
created_date: datetime | None = ...
The date and time that the deployment resource was created.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description for the deployment resource.
id
class-attribute
instance-attribute
¶
id: str | None = ...
The identifier for the deployment resource.
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.