Request Parameters Response Elements Errors See Also

DescribeInstanceSqlHaStates

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

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

DryRun

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.

Type: Boolean

Required: No

Filter.N

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).

Type: Array of Filter objects

Required: No

InstanceId.N

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.

Type: Array of strings

Required: No

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

NextToken

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

Type: String

Required: No

Response Elements

The following elements are returned by the service.

instanceSet

Information about the SQL Server High Availability instances.

Type: Array of RegisteredInstance objects

nextToken

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

Type: String

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.