/AWS1/IF_EC2=>DESCRINSTSQLHAHISTORYSTATES()

About DescribeInstanceSqlHaHistoryStates

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

Method Signature

METHODS /AWS1/IF_EC2~DESCRINSTSQLHAHISTORYSTATES
  IMPORTING
    !IT_INSTANCEIDS TYPE /AWS1/CL_EC2INSTIDSTRINGLIST_W=>TT_INSTANCEIDSTRINGLIST OPTIONAL
    !IV_STARTTIME TYPE /AWS1/EC2MILLISECONDDATETIME OPTIONAL
    !IV_ENDTIME TYPE /AWS1/EC2MILLISECONDDATETIME OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2NEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCINSQLHASTATESREQ00 OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscinsqlhahistor01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_instanceids TYPE /AWS1/CL_EC2INSTIDSTRINGLIST_W=>TT_INSTANCEIDSTRINGLIST TT_INSTANCEIDSTRINGLIST

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.

iv_starttime TYPE /AWS1/EC2MILLISECONDDATETIME /AWS1/EC2MILLISECONDDATETIME

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

iv_endtime TYPE /AWS1/EC2MILLISECONDDATETIME /AWS1/EC2MILLISECONDDATETIME

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

iv_nexttoken TYPE /AWS1/EC2NEXTTOKEN /AWS1/EC2NEXTTOKEN

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

iv_maxresults TYPE /AWS1/EC2DSCINSQLHASTATESREQ00 /AWS1/EC2DSCINSQLHASTATESREQ00

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.

it_filters TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST TT_FILTERLIST

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

• tag: - 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).

iv_dryrun TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2dscinsqlhahistor01 /AWS1/CL_EC2DSCINSQLHAHISTOR01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->descrinstsqlhahistorystates(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_instanceids = VALUE /aws1/cl_ec2instidstringlist_w=>tt_instanceidstringlist(
    ( new /aws1/cl_ec2instidstringlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_endtime = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_starttime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_instances( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_instanceid = lo_row_1->get_instanceid( ).
      lv_sqlserverlicenseusage = lo_row_1->get_sqlserverlicenseusage( ).
      lv_hastatus = lo_row_1->get_hastatus( ).
      lv_string = lo_row_1->get_processingstatus( ).
      lv_milliseconddatetime = lo_row_1->get_lastupdatedtime( ).
      lv_string = lo_row_1->get_sqlservercredentials( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.