get_stage¶
Operation¶
get_stage
¶
get_stage(request: GetStageInput | GetStageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetStageInputDict]) -> GetStageOutput
Gets information about a Stage resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetStageInput | GetStageInputDict | 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[GetStageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetStageOutput
|
An instance of |
get_stage
async
¶
get_stage(request: GetStageInput | GetStageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetStageInputDict]) -> GetStageOutput
Gets information about a Stage resource.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetStageInput | GetStageInputDict | 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[GetStageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetStageOutput
|
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.
Output¶
GetStageOutput
dataclass
¶
Bases: _SerdeShape
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Attributes¶
access_log_settings
class-attribute
instance-attribute
¶
access_log_settings: AccessLogSettings | None = ...
Settings for logging access in this stage.
cache_cluster_enabled
class-attribute
instance-attribute
¶
cache_cluster_enabled: bool = ...
Specifies whether a cache cluster is enabled for the stage. To activate
a method-level cache, set CachingEnabled to true for a method.
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.
cache_cluster_status
class-attribute
instance-attribute
¶
cache_cluster_status: str | None = ...
The status of the cache cluster for the stage, if enabled.
canary_settings
class-attribute
instance-attribute
¶
canary_settings: CanarySettings | None = ...
Settings for the canary deployment in this stage.
client_certificate_id
class-attribute
instance-attribute
¶
client_certificate_id: str | None = ...
The identifier of a client certificate for an API stage.
created_date
class-attribute
instance-attribute
¶
created_date: datetime | None = ...
The timestamp when the stage was created.
deployment_id
class-attribute
instance-attribute
¶
deployment_id: str | None = ...
The identifier of the Deployment that the stage points to.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The stage's description.
documentation_version
class-attribute
instance-attribute
¶
documentation_version: str | None = ...
The version of the associated API documentation.
last_updated_date
class-attribute
instance-attribute
¶
last_updated_date: datetime | None = ...
The timestamp when the stage last updated.
method_settings
class-attribute
instance-attribute
¶
method_settings: dict[str, MethodSetting] | None = ...
A map that defines the method settings for a Stage resource. Keys
(designated as /{method_setting_key below) are method paths defined as
{resource_path}/{http_method} for an individual method override, or
/\*/\* for overriding all methods in the stage.
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.
stage_name
class-attribute
instance-attribute
¶
stage_name: str | None = ...
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
tags
class-attribute
instance-attribute
¶
The collection of tags. Each tag element is associated with a given resource.
tracing_enabled
class-attribute
instance-attribute
¶
tracing_enabled: bool = ...
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 a Stage resource. Variable
names can have alphanumeric and underscore characters, and the values
must match [A-Za-z0-9-._~:/?#&=,]+.