Skip to content

EC2  >  Operations  >  describe_instance_sql_ha_states

describe_instance_sql_ha_states

Operation

describe_instance_sql_ha_states async 

describe_instance_sql_ha_states(input: DescribeInstanceSqlHaStatesInput, plugins: list[Plugin] | None = None) -> DescribeInstanceSqlHaStatesOutput

Describes the 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
input DescribeInstanceSqlHaStatesInput

An instance of DescribeInstanceSqlHaStatesInput.

 required
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
DescribeInstanceSqlHaStatesOutput

An instance of DescribeInstanceSqlHaStatesOutput.

Input

DescribeInstanceSqlHaStatesInput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceSqlHaStatesInput 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.

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 SQL Server High Availability 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.

Output

DescribeInstanceSqlHaStatesOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeInstanceSqlHaStatesOutput structure.

Attributes

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

Information about 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.