Skip to content

EC2  >  Operations  >  describe_instance_sql_ha_history_states

describe_instance_sql_ha_history_states

Operation

describe_instance_sql_ha_history_states async

describe_instance_sql_ha_history_states(request: DescribeInstanceSqlHaHistoryStatesInput | DescribeInstanceSqlHaHistoryStatesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeInstanceSqlHaHistoryStatesOutput
describe_instance_sql_ha_history_states(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeInstanceSqlHaHistoryStatesInputDict]) -> DescribeInstanceSqlHaHistoryStatesOutput

Describes the historical SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeInstanceSqlHaHistoryStatesOutput

An instance of DescribeInstanceSqlHaHistoryStatesOutput.

Input

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

Model

DescribeInstanceSqlHaHistoryStatesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceSqlHaHistoryStatesInput structure.

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.

end_time class-attribute instance-attribute
end_time: datetime | None = ...

The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

One or more filters to apply to the results. Supported filters include:

  • tag:``<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The tag key assigned to the instance.

  • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

  • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

instance_ids class-attribute instance-attribute
instance_ids: list[str] | None = ...

The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

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

The token to use to retrieve the next page of results.

start_time class-attribute instance-attribute
start_time: datetime | None = ...

The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

Dictionaries

DescribeInstanceSqlHaHistoryStatesInputDict

Bases: TypedDict

Dictionary form of DescribeInstanceSqlHaHistoryStatesInput.

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.

end_time instance-attribute
end_time: datetime | None

The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

One or more filters to apply to the results. Supported filters include:

  • tag:``<key> - The tag key and value pair assigned to the instance. For example, to find all instances tagged with Owner:TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The tag key assigned to the instance.

  • haStatus - The SQL Server High Availability status of the SQL Server High Availability instance (processing | active | standby | invalid).

  • sqlServerLicenseUsage - The license type for the SQL Server license (full | waived).

instance_ids instance-attribute
instance_ids: Sequence[str] | None

The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances.

max_results instance-attribute
max_results: int | None

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

next_token instance-attribute
next_token: str | None

The token to use to retrieve the next page of results.

start_time instance-attribute
start_time: datetime | None

The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states.

Timezone: UTC

Format: YYYY-MM-DDThh:mm:ss.sssZ

Output

DescribeInstanceSqlHaHistoryStatesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceSqlHaHistoryStatesOutput structure.

Attributes

instances class-attribute instance-attribute
instances: list[RegisteredInstance] | None = ...

Information about the historical SQL Server High Availability states of the SQL Server High Availability instances.

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

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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.