AWS API Changes

2025/08/28 - AWS Systems Manager for SAP - 6 new api methods

Changes Added support for Configuration Checks on SAP HANA Applications.

ListConfigurationCheckOperations (new)

Lists the configuration check operations performed by AWS Systems Manager for SAP.

Request Syntax

client.list_configuration_check_operations(
    ApplicationId='string',
    ListMode='ALL_OPERATIONS'|'LATEST_PER_CHECK',
    MaxResults=123,
    NextToken='string',
    Filters=[
        {
            'Name': 'string',
            'Value': 'string',
            'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
        },
    ]
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The ID of the application.

type ListMode:

string

param ListMode:

The mode for listing configuration check operations. Defaults to "LATEST_PER_CHECK".

LATEST_PER_CHECK - Will list the latest configuration check operation per check type.
ALL_OPERATIONS - Will list all configuration check operations performed on the application.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

type Filters:

list

param Filters:

The filters of an operation.

(dict) --

A specific result obtained by specifying the name, value, and operator.
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Value (string) -- [REQUIRED]
  
  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
- Operator (string) -- [REQUIRED]
  
  The operator for the filter.

rtype:

dict

returns:

Response Syntax

{
    'ConfigurationCheckOperations': [
        {
            'Id': 'string',
            'ApplicationId': 'string',
            'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
            'StatusMessage': 'string',
            'ConfigurationCheckId': 'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
            'ConfigurationCheckName': 'string',
            'ConfigurationCheckDescription': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'RuleStatusCounts': {
                'Failed': 123,
                'Warning': 123,
                'Info': 123,
                'Passed': 123,
                'Unknown': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConfigurationCheckOperations (list) --
  
  The configuration check operations performed by AWS Systems Manager for SAP.
  - (dict) --
    
    Represents a configuration check operation that has been executed against an application.
    - Id (string) --
      
      The unique identifier of the configuration check operation.
    - ApplicationId (string) --
      
      The ID of the application against which the configuration check was performed.
    - Status (string) --
      
      The current status of the configuration check operation.
    - StatusMessage (string) --
      
      A message providing additional details about the status of the configuration check operation.
    - ConfigurationCheckId (string) --
      
      The unique identifier of the configuration check that was performed.
    - ConfigurationCheckName (string) --
      
      The name of the configuration check that was performed.
    - ConfigurationCheckDescription (string) --
      
      A description of the configuration check that was performed.
    - StartTime (datetime) --
      
      The time at which the configuration check operation started.
    - EndTime (datetime) --
      
      The time at which the configuration check operation completed.
    - RuleStatusCounts (dict) --
      
      A summary of all the rule results, showing counts for each status type.
      - Failed (integer) --
        
        The number of rules that failed.
      - Warning (integer) --
        
        The number of rules that returned warnings.
      - Info (integer) --
        
        The number of rules that returned informational results.
      - Passed (integer) --
        
        The number of rules that passed.
      - Unknown (integer) --
        
        The number of rules with unknown status.
- 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.

GetConfigurationCheckOperation (new)

Link ¶

Gets the details of a configuration check operation by specifying the operation ID.

See also: AWS API Documentation

Request Syntax

client.get_configuration_check_operation(
    OperationId='string'
)

type OperationId:

string

param OperationId:

[REQUIRED]

The ID of the configuration check operation.

rtype:

dict

returns:

Response Syntax

{
    'ConfigurationCheckOperation': {
        'Id': 'string',
        'ApplicationId': 'string',
        'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
        'StatusMessage': 'string',
        'ConfigurationCheckId': 'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
        'ConfigurationCheckName': 'string',
        'ConfigurationCheckDescription': 'string',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'RuleStatusCounts': {
            'Failed': 123,
            'Warning': 123,
            'Info': 123,
            'Passed': 123,
            'Unknown': 123
        }
    }
}

Response Structure

(dict) --
- ConfigurationCheckOperation (dict) --
  
  Returns the details of a configuration check operation.
  - Id (string) --
    
    The unique identifier of the configuration check operation.
  - ApplicationId (string) --
    
    The ID of the application against which the configuration check was performed.
  - Status (string) --
    
    The current status of the configuration check operation.
  - StatusMessage (string) --
    
    A message providing additional details about the status of the configuration check operation.
  - ConfigurationCheckId (string) --
    
    The unique identifier of the configuration check that was performed.
  - ConfigurationCheckName (string) --
    
    The name of the configuration check that was performed.
  - ConfigurationCheckDescription (string) --
    
    A description of the configuration check that was performed.
  - StartTime (datetime) --
    
    The time at which the configuration check operation started.
  - EndTime (datetime) --
    
    The time at which the configuration check operation completed.
  - RuleStatusCounts (dict) --
    
    A summary of all the rule results, showing counts for each status type.
    - Failed (integer) --
      
      The number of rules that failed.
    - Warning (integer) --
      
      The number of rules that returned warnings.
    - Info (integer) --
      
      The number of rules that returned informational results.
    - Passed (integer) --
      
      The number of rules that passed.
    - Unknown (integer) --
      
      The number of rules with unknown status.

ListSubCheckResults (new)

Link ¶

Lists the sub-check results of a specified configuration check operation.

See also: AWS API Documentation

Request Syntax

client.list_sub_check_results(
    OperationId='string',
    MaxResults=123,
    NextToken='string'
)

type OperationId:

string

param OperationId:

[REQUIRED]

The ID of the configuration check operation.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'SubCheckResults': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'References': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- SubCheckResults (list) --
  
  The sub-check results of a configuration check operation.
  - (dict) --
    
    Represents the result of a sub-check within a configuration check operation.
    - Id (string) --
      
      The unique identifier of the sub-check result.
    - Name (string) --
      
      The name of the sub-check.
    - Description (string) --
      
      A description of what the sub-check validates.
    - References (list) --
      
      A list of references or documentation links related to the sub-check.
      - (string) --
- 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.

ListSubCheckRuleResults (new)

Link ¶

Lists the rules of a specified sub-check belonging to a configuration check operation.

See also: AWS API Documentation

Request Syntax

client.list_sub_check_rule_results(
    SubCheckResultId='string',
    MaxResults=123,
    NextToken='string'
)

type SubCheckResultId:

string

param SubCheckResultId:

[REQUIRED]

The ID of the sub check result.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'RuleResults': [
        {
            'Id': 'string',
            'Description': 'string',
            'Status': 'PASSED'|'FAILED'|'WARNING'|'INFO'|'UNKNOWN',
            'Message': 'string',
            'Metadata': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- RuleResults (list) --
  
  The rule results of a sub-check belonging to a configuration check operation.
  - (dict) --
    
    Represents the result of a single rule within a configuration check.
    - Id (string) --
      
      The unique identifier of the rule result.
    - Description (string) --
      
      A description of what the rule validates.
    - Status (string) --
      
      The status of the rule result.
    - Message (string) --
      
      A message providing details about the rule result.
    - Metadata (dict) --
      
      Additional metadata associated with the rule result.
      - (string) --
        
        (string) --
- 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.

StartConfigurationChecks (new)

Link ¶

Initiates configuration check operations against a specified application.

See also: AWS API Documentation

Request Syntax

client.start_configuration_checks(
    ApplicationId='string',
    ConfigurationCheckIds=[
        'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
    ]
)

type ApplicationId:

string

param ApplicationId:

[REQUIRED]

The ID of the application.

type ConfigurationCheckIds:

list

param ConfigurationCheckIds:

The list of configuration checks to perform.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ConfigurationCheckOperations': [
        {
            'Id': 'string',
            'ApplicationId': 'string',
            'Status': 'INPROGRESS'|'SUCCESS'|'ERROR',
            'StatusMessage': 'string',
            'ConfigurationCheckId': 'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
            'ConfigurationCheckName': 'string',
            'ConfigurationCheckDescription': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'RuleStatusCounts': {
                'Failed': 123,
                'Warning': 123,
                'Info': 123,
                'Passed': 123,
                'Unknown': 123
            }
        },
    ]
}

Response Structure

(dict) --
- ConfigurationCheckOperations (list) --
  
  The configuration check operations that were started.
  - (dict) --
    
    Represents a configuration check operation that has been executed against an application.
    - Id (string) --
      
      The unique identifier of the configuration check operation.
    - ApplicationId (string) --
      
      The ID of the application against which the configuration check was performed.
    - Status (string) --
      
      The current status of the configuration check operation.
    - StatusMessage (string) --
      
      A message providing additional details about the status of the configuration check operation.
    - ConfigurationCheckId (string) --
      
      The unique identifier of the configuration check that was performed.
    - ConfigurationCheckName (string) --
      
      The name of the configuration check that was performed.
    - ConfigurationCheckDescription (string) --
      
      A description of the configuration check that was performed.
    - StartTime (datetime) --
      
      The time at which the configuration check operation started.
    - EndTime (datetime) --
      
      The time at which the configuration check operation completed.
    - RuleStatusCounts (dict) --
      
      A summary of all the rule results, showing counts for each status type.
      - Failed (integer) --
        
        The number of rules that failed.
      - Warning (integer) --
        
        The number of rules that returned warnings.
      - Info (integer) --
        
        The number of rules that returned informational results.
      - Passed (integer) --
        
        The number of rules that passed.
      - Unknown (integer) --
        
        The number of rules with unknown status.

ListConfigurationCheckDefinitions (new)

Link ¶

Lists all configuration check types supported by AWS Systems Manager for SAP.

See also: AWS API Documentation

Request Syntax

client.list_configuration_check_definitions(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type NextToken:

string

param NextToken:

The token for the next page of results.

rtype:

dict

returns:

Response Syntax

{
    'ConfigurationChecks': [
        {
            'Id': 'SAP_CHECK_01'|'SAP_CHECK_02'|'SAP_CHECK_03',
            'Name': 'string',
            'Description': 'string',
            'ApplicableApplicationTypes': [
                'HANA'|'SAP_ABAP',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConfigurationChecks (list) --
  
  The configuration check types supported by AWS Systems Manager for SAP.
  - (dict) --
    
    Represents a configuration check definition supported by AWS Systems Manager for SAP.
    - Id (string) --
      
      The unique identifier of the configuration check.
    - Name (string) --
      
      The name of the configuration check.
    - Description (string) --
      
      A description of what the configuration check validates.
    - ApplicableApplicationTypes (list) --
      
      The list of SSMSAP application types that this configuration check can be evaluated against.
      - (string) --
- 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.