describe_scheduled_instances¶
Operation¶
describe_scheduled_instances
¶
describe_scheduled_instances(request: DescribeScheduledInstancesInput | DescribeScheduledInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeScheduledInstancesInputDict]) -> DescribeScheduledInstancesOutput
Describes the specified Scheduled Instances or all your Scheduled Instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeScheduledInstancesInput | DescribeScheduledInstancesInputDict | 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[DescribeScheduledInstancesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeScheduledInstancesOutput
|
An instance of |
describe_scheduled_instances
async
¶
describe_scheduled_instances(request: DescribeScheduledInstancesInput | DescribeScheduledInstancesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeScheduledInstancesInputDict]) -> DescribeScheduledInstancesOutput
Describes the specified Scheduled Instances or all your Scheduled Instances.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeScheduledInstancesInput | DescribeScheduledInstancesInputDict | 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[DescribeScheduledInstancesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeScheduledInstancesOutput
|
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.
DescribeScheduledInstancesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeScheduledInstancesInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters.
-
availability-zone- The Availability Zone (for example,us-west-2a). -
instance-type- The instance type (for example,c4.large). -
platform- The platform (Linux/UNIXorWindows).
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 100. To retrieve the
remaining results, make another call with the returned NextToken
value.
scheduled_instance_ids
instance-attribute
¶
The Scheduled Instance IDs.
slot_start_time_range
instance-attribute
¶
slot_start_time_range: SlotStartTimeRangeRequest | SlotStartTimeRangeRequestDict | None
The time period for the first schedule to start.
DescribeScheduledInstancesInput
dataclass
¶
Bases: _SerdeShape
Contains the parameters for DescribeScheduledInstances.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
The filters.
-
availability-zone- The Availability Zone (for example,us-west-2a). -
instance-type- The instance type (for example,c4.large). -
platform- The platform (Linux/UNIXorWindows).
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in a single call. This value can
be between 5 and 300. The default value is 100. To retrieve the
remaining results, make another call with the returned NextToken
value.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token for the next set of results.
scheduled_instance_ids
class-attribute
instance-attribute
¶
The Scheduled Instance IDs.
slot_start_time_range
class-attribute
instance-attribute
¶
slot_start_time_range: SlotStartTimeRangeRequest | None = ...
The time period for the first schedule to start.
Output¶
DescribeScheduledInstancesOutput
dataclass
¶
Bases: _SerdeShape
Contains the output of DescribeScheduledInstances.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token required to retrieve the next set of results. This value is
null when there are no more results to return.
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.
scheduled_instance_set
class-attribute
instance-attribute
¶
scheduled_instance_set: list[ScheduledInstance] | None = ...
Information about the Scheduled Instances.