EC2 / Client / describe_instance_sql_ha_states

describe_instance_sql_ha_states¶

EC2.Client.describe_instance_sql_ha_states(**kwargs)¶

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

Request Syntax

response = client.describe_instance_sql_ha_states(
    InstanceIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

InstanceIds (list) –
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.
- (string) –
NextToken (string) – The token to use to retrieve the next page of results.
MaxResults (integer) – 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 (list) –
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).
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
DryRun (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'InstanceId': 'string',
            'SqlServerLicenseUsage': 'full'|'waived',
            'HaStatus': 'processing'|'active'|'standby'|'invalid',
            'ProcessingStatus': 'string',
            'LastUpdatedTime': datetime(2015, 1, 1),
            'SqlServerCredentials': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Instances (list) –
  
  Information about the SQL Server High Availability instances.
  - (dict) –
    
    Describes an Amazon EC2 instance that is enabled for SQL Server High Availability standby detection monitoring.
    - InstanceId (string) –
      
      The ID of the SQL Server High Availability instance.
    - SqlServerLicenseUsage (string) –
      
      The license type for the SQL Server license. Valid values include:
      - full - The SQL Server High Availability instance is using a full SQL Server license.
      - waived - The SQL Server High Availability instance is waived from the SQL Server license.
    - HaStatus (string) –
      
      The SQL Server High Availability status of the instance. Valid values are:
      - processing - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.
      - active - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.
      - standby - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.
      - invalid - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.
    - ProcessingStatus (string) –
      
      A brief description of the SQL Server High Availability status. If the instance is in the invalid High Availability status, this parameter includes the error message.
    - LastUpdatedTime (datetime) –
      
      The date and time when the instance’s SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).
    - SqlServerCredentials (string) –
      
      The ARN of the Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the Amazon Web Services Systems Manager agent.
    - Tags (list) –
      
      The tags assigned to the SQL Server High Availability instance.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.