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

Description¶

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

Usage¶

ec2_describe_instance_sql_ha_states(InstanceIds, NextToken, MaxResults,
  Filters, DryRun)

Arguments¶

• InstanceIds

  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.

• NextToken

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

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

• Filters

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

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

Value¶

A list with the following syntax:

list(
  Instances = list(
    list(
      InstanceId = "string",
      SqlServerLicenseUsage = "full"|"waived",
      HaStatus = "processing"|"active"|"standby"|"invalid",
      ProcessingStatus = "string",
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      SqlServerCredentials = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_instance_sql_ha_states(
  InstanceIds = list(
    "string"
  ),
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  DryRun = TRUE|FALSE
)