SDK for PHP 3.x

Client: Aws\SsmSap\SsmSapClient
Service ID: ssm-sap
Version: 2018-05-10

This page describes the parameters and results for the operations of the AWS Systems Manager for SAP (2018-05-10), and shows how to use the Aws\SsmSap\SsmSapClient object to call the described operations. This documentation is specific to the 2018-05-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

DeleteResourcePermission ( array $params = [] )
Removes permissions associated with the target database.
DeregisterApplication ( array $params = [] )
Deregister an SAP application with AWS Systems Manager for SAP.
GetApplication ( array $params = [] )
Gets an application registered with AWS Systems Manager for SAP.
GetComponent ( array $params = [] )
Gets the component of an application registered with AWS Systems Manager for SAP.
GetDatabase ( array $params = [] )
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
GetOperation ( array $params = [] )
Gets the details of an operation by specifying the operation ID.
GetResourcePermission ( array $params = [] )
Gets permissions associated with the target database.
ListApplications ( array $params = [] )
Lists all the applications registered with AWS Systems Manager for SAP.
ListComponents ( array $params = [] )
Lists all the components registered with AWS Systems Manager for SAP.
ListDatabases ( array $params = [] )
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
ListOperationEvents ( array $params = [] )
Returns a list of operations events.
ListOperations ( array $params = [] )
Lists the operations performed by AWS Systems Manager for SAP.
ListTagsForResource ( array $params = [] )
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
PutResourcePermission ( array $params = [] )
Adds permissions to the target database.
RegisterApplication ( array $params = [] )
Register an SAP application with AWS Systems Manager for SAP.
StartApplication ( array $params = [] )
Request is an operation which starts an application.
StartApplicationRefresh ( array $params = [] )
Refreshes a registered application.
StopApplication ( array $params = [] )
Request is an operation to stop an application.
TagResource ( array $params = [] )
Creates tag for a resource by specifying the ARN.
UntagResource ( array $params = [] )
Delete the tags for a resource.
UpdateApplicationSettings ( array $params = [] )
Updates the settings of an application registered with AWS Systems Manager for SAP.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListApplications
ListComponents
ListDatabases
ListOperationEvents
ListOperations

Operations

DeleteResourcePermission

$result = $client->deleteResourcePermission([/* ... */]);
$promise = $client->deleteResourcePermissionAsync([/* ... */]);

Removes permissions associated with the target database.

Parameter Syntax

$result = $client->deleteResourcePermission([
    'ActionType' => 'RESTORE',
    'ResourceArn' => '<string>', // REQUIRED
    'SourceResourceArn' => '<string>',
]);

Parameter Details

Members
ActionType
Type: string

Delete or restore the permissions on the target database.

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

SourceResourceArn
Type: string

The Amazon Resource Name (ARN) of the source resource.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members
Policy
Type: string

The policy that removes permissions on the target database.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

DeregisterApplication

$result = $client->deregisterApplication([/* ... */]);
$promise = $client->deregisterApplicationAsync([/* ... */]);

Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.

Parameter Syntax

$result = $client->deregisterApplication([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

UnauthorizedException:

The request is not authorized.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

Parameter Syntax

$result = $client->getApplication([
    'AppRegistryArn' => '<string>',
    'ApplicationArn' => '<string>',
    'ApplicationId' => '<string>',
]);

Parameter Details

Members
AppRegistryArn
Type: string

The Amazon Resource Name (ARN) of the application registry.

ApplicationArn
Type: string

The Amazon Resource Name (ARN) of the application.

ApplicationId
Type: string

The ID of the application.

Result Syntax

[
    'Application' => [
        'AppRegistryArn' => '<string>',
        'Arn' => '<string>',
        'AssociatedApplicationArns' => ['<string>', ...],
        'Components' => ['<string>', ...],
        'DiscoveryStatus' => 'SUCCESS|REGISTRATION_FAILED|REFRESH_FAILED|REGISTERING|DELETING',
        'Id' => '<string>',
        'LastUpdated' => <DateTime>,
        'Status' => 'ACTIVATED|STARTING|STOPPED|STOPPING|FAILED|REGISTERING|DELETING|UNKNOWN',
        'StatusMessage' => '<string>',
        'Type' => 'HANA|SAP_ABAP',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
Application
Type: Application structure

Returns all of the metadata of an application registered with AWS Systems Manager for SAP.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of a registered application.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

GetComponent

$result = $client->getComponent([/* ... */]);
$promise = $client->getComponentAsync([/* ... */]);

Gets the component of an application registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->getComponent([
    'ApplicationId' => '<string>', // REQUIRED
    'ComponentId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

ComponentId
Required: Yes
Type: string

The ID of the component.

Result Syntax

[
    'Component' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'AssociatedHost' => [
            'Ec2InstanceId' => '<string>',
            'Hostname' => '<string>',
            'IpAddresses' => [
                [
                    'AllocationType' => 'VPC_SUBNET|ELASTIC_IP|OVERLAY|UNKNOWN',
                    'IpAddress' => '<string>',
                    'Primary' => true || false,
                ],
                // ...
            ],
            'OsVersion' => '<string>',
        ],
        'ChildComponents' => ['<string>', ...],
        'ComponentId' => '<string>',
        'ComponentType' => 'HANA|HANA_NODE|ABAP|ASCS|DIALOG|WEBDISP|WD|ERS',
        'DatabaseConnection' => [
            'ConnectionIp' => '<string>',
            'DatabaseArn' => '<string>',
            'DatabaseConnectionMethod' => 'DIRECT|OVERLAY',
        ],
        'Databases' => ['<string>', ...],
        'HdbVersion' => '<string>',
        'Hosts' => [
            [
                'EC2InstanceId' => '<string>',
                'HostIp' => '<string>',
                'HostName' => '<string>',
                'HostRole' => 'LEADER|WORKER|STANDBY|UNKNOWN',
                'InstanceId' => '<string>',
                'OsVersion' => '<string>',
            ],
            // ...
        ],
        'LastUpdated' => <DateTime>,
        'ParentComponent' => '<string>',
        'PrimaryHost' => '<string>',
        'Resilience' => [
            'ClusterStatus' => 'ONLINE|STANDBY|MAINTENANCE|OFFLINE|NONE',
            'EnqueueReplication' => true || false,
            'HsrOperationMode' => 'PRIMARY|LOGREPLAY|DELTA_DATASHIPPING|LOGREPLAY_READACCESS|NONE',
            'HsrReplicationMode' => 'PRIMARY|NONE|SYNC|SYNCMEM|ASYNC',
            'HsrTier' => '<string>',
        ],
        'SapFeature' => '<string>',
        'SapHostname' => '<string>',
        'SapKernelVersion' => '<string>',
        'Sid' => '<string>',
        'Status' => 'ACTIVATED|STARTING|STOPPED|STOPPING|RUNNING|RUNNING_WITH_ERROR|UNDEFINED',
        'SystemNumber' => '<string>',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
Component
Type: Component structure

The component of an application registered with AWS Systems Manager for SAP.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of a component.

Errors

UnauthorizedException:

The request is not authorized.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

GetDatabase

$result = $client->getDatabase([/* ... */]);
$promise = $client->getDatabaseAsync([/* ... */]);

Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->getDatabase([
    'ApplicationId' => '<string>',
    'ComponentId' => '<string>',
    'DatabaseArn' => '<string>',
    'DatabaseId' => '<string>',
]);

Parameter Details

Members
ApplicationId
Type: string

The ID of the application.

ComponentId
Type: string

The ID of the component.

DatabaseArn
Type: string

The Amazon Resource Name (ARN) of the database.

DatabaseId
Type: string

The ID of the database.

Result Syntax

[
    'Database' => [
        'ApplicationId' => '<string>',
        'Arn' => '<string>',
        'ComponentId' => '<string>',
        'ConnectedComponentArns' => ['<string>', ...],
        'Credentials' => [
            [
                'CredentialType' => 'ADMIN',
                'DatabaseName' => '<string>',
                'SecretId' => '<string>',
            ],
            // ...
        ],
        'DatabaseId' => '<string>',
        'DatabaseName' => '<string>',
        'DatabaseType' => 'SYSTEM|TENANT',
        'LastUpdated' => <DateTime>,
        'PrimaryHost' => '<string>',
        'SQLPort' => <integer>,
        'Status' => 'RUNNING|STARTING|STOPPED|WARNING|UNKNOWN|ERROR',
    ],
    'Tags' => ['<string>', ...],
]

Result Details

Members
Database
Type: Database structure

The SAP HANA database of an application registered with AWS Systems Manager for SAP.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of a database.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

GetOperation

$result = $client->getOperation([/* ... */]);
$promise = $client->getOperationAsync([/* ... */]);

Gets the details of an operation by specifying the operation ID.

Parameter Syntax

$result = $client->getOperation([
    'OperationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
OperationId
Required: Yes
Type: string

The ID of the operation.

Result Syntax

[
    'Operation' => [
        'EndTime' => <DateTime>,
        'Id' => '<string>',
        'LastUpdatedTime' => <DateTime>,
        'Properties' => ['<string>', ...],
        'ResourceArn' => '<string>',
        'ResourceId' => '<string>',
        'ResourceType' => '<string>',
        'StartTime' => <DateTime>,
        'Status' => 'INPROGRESS|SUCCESS|ERROR',
        'StatusMessage' => '<string>',
        'Type' => '<string>',
    ],
]

Result Details

Members
Operation
Type: Operation structure

Returns the details of an operation.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

GetResourcePermission

$result = $client->getResourcePermission([/* ... */]);
$promise = $client->getResourcePermissionAsync([/* ... */]);

Gets permissions associated with the target database.

Parameter Syntax

$result = $client->getResourcePermission([
    'ActionType' => 'RESTORE',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ActionType
Type: string

ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members
Policy
Type: string

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Lists all the applications registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->listApplications([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Operator' => 'Equals|GreaterThanOrEquals|LessThanOrEquals', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
Filters
Type: Array of Filter structures

The filter of name, value, and operator.

MaxResults
Type: int

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

NextToken
Type: string

The token for the next page of results.

Result Syntax

[
    'Applications' => [
        [
            'Arn' => '<string>',
            'DiscoveryStatus' => 'SUCCESS|REGISTRATION_FAILED|REFRESH_FAILED|REGISTERING|DELETING',
            'Id' => '<string>',
            'Tags' => ['<string>', ...],
            'Type' => 'HANA|SAP_ABAP',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Applications
Type: Array of ApplicationSummary structures

The applications registered with AWS Systems Manager for SAP.

NextToken
Type: string

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

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListComponents

$result = $client->listComponents([/* ... */]);
$promise = $client->listComponentsAsync([/* ... */]);

Lists all the components registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->listComponents([
    'ApplicationId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ApplicationId
Type: string

The ID of the application.

MaxResults
Type: int

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

If you do not specify a value for MaxResults, the request returns 50 items per page by default.

NextToken
Type: string

The token for the next page of results.

Result Syntax

[
    'Components' => [
        [
            'ApplicationId' => '<string>',
            'Arn' => '<string>',
            'ComponentId' => '<string>',
            'ComponentType' => 'HANA|HANA_NODE|ABAP|ASCS|DIALOG|WEBDISP|WD|ERS',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Components
Type: Array of ComponentSummary structures

List of components registered with AWS System Manager for SAP.

NextToken
Type: string

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

Errors

UnauthorizedException:

The request is not authorized.

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListDatabases

$result = $client->listDatabases([/* ... */]);
$promise = $client->listDatabasesAsync([/* ... */]);

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->listDatabases([
    'ApplicationId' => '<string>',
    'ComponentId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ApplicationId
Type: string

The ID of the application.

ComponentId
Type: string

The ID of the component.

MaxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

NextToken
Type: string

The token for the next page of results.

Result Syntax

[
    'Databases' => [
        [
            'ApplicationId' => '<string>',
            'Arn' => '<string>',
            'ComponentId' => '<string>',
            'DatabaseId' => '<string>',
            'DatabaseType' => 'SYSTEM|TENANT',
            'Tags' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
Databases
Type: Array of DatabaseSummary structures

The SAP HANA databases of an application.

NextToken
Type: string

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

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListOperationEvents

$result = $client->listOperationEvents([/* ... */]);
$promise = $client->listOperationEventsAsync([/* ... */]);

Returns a list of operations events.

Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.

Parameter Syntax

$result = $client->listOperationEvents([
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Operator' => 'Equals|GreaterThanOrEquals|LessThanOrEquals', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'OperationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Filters
Type: Array of Filter structures

Optionally specify filters to narrow the returned operation event items.

Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals.

MaxResults
Type: int

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

If you do not specify a value for MaxResults, the request returns 50 items per page by default.

NextToken
Type: string

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

OperationId
Required: Yes
Type: string

The ID of the operation.

Result Syntax

[
    'NextToken' => '<string>',
    'OperationEvents' => [
        [
            'Description' => '<string>',
            'Resource' => [
                'ResourceArn' => '<string>',
                'ResourceType' => '<string>',
            ],
            'Status' => 'IN_PROGRESS|COMPLETED|FAILED',
            'StatusMessage' => '<string>',
            'Timestamp' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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

OperationEvents
Type: Array of OperationEvent structures

A returned list of operation events that meet the filter criteria.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListOperations

$result = $client->listOperations([/* ... */]);
$promise = $client->listOperationsAsync([/* ... */]);

Lists the operations performed by AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->listOperations([
    'ApplicationId' => '<string>', // REQUIRED
    'Filters' => [
        [
            'Name' => '<string>', // REQUIRED
            'Operator' => 'Equals|GreaterThanOrEquals|LessThanOrEquals', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

Filters
Type: Array of Filter structures

The filters of an operation.

MaxResults
Type: int

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default.

NextToken
Type: string

The token for the next page of results.

Result Syntax

[
    'NextToken' => '<string>',
    'Operations' => [
        [
            'EndTime' => <DateTime>,
            'Id' => '<string>',
            'LastUpdatedTime' => <DateTime>,
            'Properties' => ['<string>', ...],
            'ResourceArn' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'StartTime' => <DateTime>,
            'Status' => 'INPROGRESS|SUCCESS|ERROR',
            'StatusMessage' => '<string>',
            'Type' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
NextToken
Type: string

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

Operations
Type: Array of Operation structures

List of operations performed by AWS Systems Manager for SAP.

Errors

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

PutResourcePermission

$result = $client->putResourcePermission([/* ... */]);
$promise = $client->putResourcePermissionAsync([/* ... */]);

Adds permissions to the target database.

Parameter Syntax

$result = $client->putResourcePermission([
    'ActionType' => 'RESTORE', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
    'SourceResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ActionType
Required: Yes
Type: string

ResourceArn
Required: Yes
Type: string

SourceResourceArn
Required: Yes
Type: string

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members
Policy
Type: string

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

InternalServerException:

An internal error has occurred.

RegisterApplication

$result = $client->registerApplication([/* ... */]);
$promise = $client->registerApplicationAsync([/* ... */]);

Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.

The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.

AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.

Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.

Parameter Syntax

$result = $client->registerApplication([
    'ApplicationId' => '<string>', // REQUIRED
    'ApplicationType' => 'HANA|SAP_ABAP', // REQUIRED
    'Credentials' => [
        [
            'CredentialType' => 'ADMIN', // REQUIRED
            'DatabaseName' => '<string>', // REQUIRED
            'SecretId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DatabaseArn' => '<string>',
    'Instances' => ['<string>', ...], // REQUIRED
    'SapInstanceNumber' => '<string>',
    'Sid' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

ApplicationType
Required: Yes
Type: string

The type of the application.

Credentials
Type: Array of ApplicationCredential structures

The credentials of the SAP application.

DatabaseArn
Type: string

The Amazon Resource Name of the SAP HANA database.

Instances
Required: Yes
Type: Array of strings

The Amazon EC2 instances on which your SAP application is running.

SapInstanceNumber
Type: string

The SAP instance number of the application.

Sid
Type: string

The System ID of the application.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags to be attached to the SAP application.

Result Syntax

[
    'Application' => [
        'AppRegistryArn' => '<string>',
        'Arn' => '<string>',
        'AssociatedApplicationArns' => ['<string>', ...],
        'Components' => ['<string>', ...],
        'DiscoveryStatus' => 'SUCCESS|REGISTRATION_FAILED|REFRESH_FAILED|REGISTERING|DELETING',
        'Id' => '<string>',
        'LastUpdated' => <DateTime>,
        'Status' => 'ACTIVATED|STARTING|STOPPED|STOPPING|FAILED|REGISTERING|DELETING|UNKNOWN',
        'StatusMessage' => '<string>',
        'Type' => 'HANA|SAP_ABAP',
    ],
    'OperationId' => '<string>',
]

Result Details

Members
Application
Type: Application structure

The application registered with AWS Systems Manager for SAP.

OperationId
Type: string

The ID of the operation.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

InternalServerException:

An internal error has occurred.

StartApplication

$result = $client->startApplication([/* ... */]);
$promise = $client->startApplicationAsync([/* ... */]);

Request is an operation which starts an application.

Parameter ApplicationId is required.

Parameter Syntax

$result = $client->startApplication([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The ID of the operation.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

InternalServerException:

An internal error has occurred.

StartApplicationRefresh

$result = $client->startApplicationRefresh([/* ... */]);
$promise = $client->startApplicationRefreshAsync([/* ... */]);

Refreshes a registered application.

Parameter Syntax

$result = $client->startApplicationRefresh([
    'ApplicationId' => '<string>', // REQUIRED
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The ID of the operation.

Errors

UnauthorizedException:

The request is not authorized.

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

InternalServerException:

An internal error has occurred.

StopApplication

$result = $client->stopApplication([/* ... */]);
$promise = $client->stopApplicationAsync([/* ... */]);

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

Parameter Syntax

$result = $client->stopApplication([
    'ApplicationId' => '<string>', // REQUIRED
    'IncludeEc2InstanceShutdown' => true || false,
    'StopConnectedEntity' => 'DBMS',
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

IncludeEc2InstanceShutdown
Type: boolean

Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

StopConnectedEntity
Type: string

Specify the ConnectedEntityType. Accepted type is DBMS.

If this parameter is included, the connected DBMS (Database Management System) will be stopped.

Result Syntax

[
    'OperationId' => '<string>',
]

Result Details

Members
OperationId
Type: string

The ID of the operation.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

InternalServerException:

An internal error has occurred.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Creates tag for a resource by specifying the ARN.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags on a resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Delete the tags for a resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

tagKeys
Required: Yes
Type: Array of strings

Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

UpdateApplicationSettings

$result = $client->updateApplicationSettings([/* ... */]);
$promise = $client->updateApplicationSettingsAsync([/* ... */]);

Updates the settings of an application registered with AWS Systems Manager for SAP.

Parameter Syntax

$result = $client->updateApplicationSettings([
    'ApplicationId' => '<string>', // REQUIRED
    'Backint' => [
        'BackintMode' => 'AWSBackup', // REQUIRED
        'EnsureNoBackupInProcess' => true || false, // REQUIRED
    ],
    'CredentialsToAddOrUpdate' => [
        [
            'CredentialType' => 'ADMIN', // REQUIRED
            'DatabaseName' => '<string>', // REQUIRED
            'SecretId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'CredentialsToRemove' => [
        [
            'CredentialType' => 'ADMIN', // REQUIRED
            'DatabaseName' => '<string>', // REQUIRED
            'SecretId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DatabaseArn' => '<string>',
]);

Parameter Details

Members
ApplicationId
Required: Yes
Type: string

The ID of the application.

Backint
Type: BackintConfig structure

Installation of AWS Backint Agent for SAP HANA.

CredentialsToAddOrUpdate
Type: Array of ApplicationCredential structures

The credentials to be added or updated.

CredentialsToRemove
Type: Array of ApplicationCredential structures

The credentials to be removed.

DatabaseArn
Type: string

The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

Result Syntax

[
    'Message' => '<string>',
    'OperationIds' => ['<string>', ...],
]

Result Details

Members
Message
Type: string

The update message.

OperationIds
Type: Array of strings

The IDs of the operations.

Errors

UnauthorizedException:

The request is not authorized.

ResourceNotFoundException:

The resource is not available.

ValidationException:

The input fails to satisfy the constraints specified by an AWS service.

ConflictException:

A conflict has occurred.

InternalServerException:

An internal error has occurred.

Shapes

Application

Description

An SAP application registered with AWS Systems Manager for SAP.

Members
AppRegistryArn
Type: string

The Amazon Resource Name (ARN) of the Application Registry.

Arn
Type: string

The Amazon Resource Name (ARN) of the application.

AssociatedApplicationArns
Type: Array of strings

The Amazon Resource Names of the associated AWS Systems Manager for SAP applications.

Components
Type: Array of strings

The components of the application.

DiscoveryStatus
Type: string

The latest discovery result for the application.

Id
Type: string

The ID of the application.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the application was last updated.

Status
Type: string

The status of the application.

StatusMessage
Type: string

The status message.

Type
Type: string

The type of the application.

ApplicationCredential

Description

The credentials of your SAP application.

Members
CredentialType
Required: Yes
Type: string

The type of the application credentials.

DatabaseName
Required: Yes
Type: string

The name of the SAP HANA database.

SecretId
Required: Yes
Type: string

The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

ApplicationSummary

Description

The summary of the SAP application registered with AWS Systems Manager for SAP.

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the application.

DiscoveryStatus
Type: string

The status of the latest discovery.

Id
Type: string

The ID of the application.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags on the application.

Type
Type: string

The type of the application.

AssociatedHost

Description

Describes the properties of the associated host.

Members
Ec2InstanceId
Type: string

The ID of the Amazon EC2 instance.

Hostname
Type: string

The name of the host.

IpAddresses
Type: Array of IpAddressMember structures

The IP addresses of the associated host.

OsVersion
Type: string

The version of the operating system.

BackintConfig

Description

Configuration parameters for AWS Backint Agent for SAP HANA. You can backup your SAP HANA database with AWS Backup or Amazon S3.

Members
BackintMode
Required: Yes
Type: string

AWS service for your database backup.

EnsureNoBackupInProcess
Required: Yes
Type: boolean

Component

Description

The SAP component of your application.

Members
ApplicationId
Type: string

The ID of the application.

Arn
Type: string

The Amazon Resource Name (ARN) of the component.

AssociatedHost
Type: AssociatedHost structure

The associated host of the component.

ChildComponents
Type: Array of strings

The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.

ComponentId
Type: string

The ID of the component.

ComponentType
Type: string

The type of the component.

DatabaseConnection
Type: DatabaseConnection structure

The connection specifications for the database of the component.

Databases
Type: Array of strings

The SAP HANA databases of the component.

HdbVersion
Type: string

The SAP HANA version of the component.

Hosts
Type: Array of Host structures

The hosts of the component.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the component was last updated.

ParentComponent
Type: string

The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.

PrimaryHost
Type: string

The primary host of the component.

Resilience
Type: Resilience structure

Details of the SAP HANA system replication for the component.

SapFeature
Type: string

The SAP feature of the component.

SapHostname
Type: string

The hostname of the component.

SapKernelVersion
Type: string

The kernel version of the component.

Sid
Type: string

The SAP System Identifier of the application component.

Status
Type: string

The status of the component.

  • ACTIVATED - this status has been deprecated.

  • STARTING - the component is in the process of being started.

  • STOPPED - the component is not running.

  • STOPPING - the component is in the process of being stopped.

  • RUNNING - the component is running.

  • RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.

  • UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.

SystemNumber
Type: string

The SAP system number of the application component.

ComponentSummary

Description

The summary of the component.

Members
ApplicationId
Type: string

The ID of the application.

Arn
Type: string

The Amazon Resource Name (ARN) of the component summary.

ComponentId
Type: string

The ID of the component.

ComponentType
Type: string

The type of the component.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the component.

ConflictException

Description

A conflict has occurred.

Members
Message
Type: string

Database

Description

The SAP HANA database of the application registered with AWS Systems Manager for SAP.

Members
ApplicationId
Type: string

The ID of the application.

Arn
Type: string

The Amazon Resource Name (ARN) of the database.

ComponentId
Type: string

The ID of the component.

ConnectedComponentArns
Type: Array of strings

The Amazon Resource Names of the connected AWS Systems Manager for SAP components.

Credentials
Type: Array of ApplicationCredential structures

The credentials of the database.

DatabaseId
Type: string

The ID of the SAP HANA database.

DatabaseName
Type: string

The name of the database.

DatabaseType
Type: string

The type of the database.

LastUpdated
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the database was last updated.

PrimaryHost
Type: string

The primary host of the database.

SQLPort
Type: int

The SQL port of the database.

Status
Type: string

The status of the database.

DatabaseConnection

Description

The connection specifications for the database.

Members
ConnectionIp
Type: string

The IP address for connection.

DatabaseArn
Type: string

The Amazon Resource Name of the connected SAP HANA database.

DatabaseConnectionMethod
Type: string

The method of connection.

DatabaseSummary

Description

The summary of the database.

Members
ApplicationId
Type: string

The ID of the application.

Arn
Type: string

The Amazon Resource Name (ARN) of the database.

ComponentId
Type: string

The ID of the component.

DatabaseId
Type: string

The ID of the database.

DatabaseType
Type: string

The type of the database.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags of the database.

Filter

Description

A specific result obtained by specifying the name, value, and operator.

Members
Name
Required: Yes
Type: string

The name of the filter. Filter names are case-sensitive.

Operator
Required: Yes
Type: string

The operator for the filter.

Value
Required: Yes
Type: string

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

Host

Description

Describes the properties of the Dedicated Host.

Members
EC2InstanceId
Type: string

The ID of Amazon EC2 instance.

HostIp
Type: string

The IP address of the Dedicated Host.

HostName
Type: string

The name of the Dedicated Host.

HostRole
Type: string

The role of the Dedicated Host.

InstanceId
Type: string

The instance ID of the instance on the Dedicated Host.

OsVersion
Type: string

The version of the operating system.

InternalServerException

Description

An internal error has occurred.

Members
Message
Type: string

IpAddressMember

Description

Provides information of the IP address.

Members
AllocationType
Type: string

The type of allocation for the IP address.

IpAddress
Type: string

The IP address.

Primary
Type: boolean

The primary IP address.

Operation

Description

The operations performed by AWS Systems Manager for SAP.

Members
EndTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The end time of the operation.

Id
Type: string

The ID of the operation.

LastUpdatedTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the operation was last updated.

Properties
Type: Associative array of custom strings keys (String) to strings

The properties of the operation.

ResourceArn
Type: string

The Amazon Resource Name (ARN) of the operation.

ResourceId
Type: string

The resource ID of the operation.

ResourceType
Type: string

The resource type of the operation.

StartTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

The start time of the operation.

Status
Type: string

The status of the operation.

StatusMessage
Type: string

The status message of the operation.

Type
Type: string

The type of the operation.

OperationEvent

Description

An operation event returns details for an operation, including key milestones which can be used to monitor and track operations in progress.

Operation events contain:

  • Description string

  • Resource, including its ARN and type

  • Status

  • StatusMessage string

  • TimeStamp

Operation event examples include StartApplication or StopApplication.

Members
Description
Type: string

A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

Resource
Type: Resource structure

The resource involved in the operations event.

Contains ResourceArn ARN and ResourceType.

Status
Type: string

The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

StatusMessage
Type: string

The status message relating to a specific operation event.

Timestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of the specified operation event.

Resilience

Description

Details of the SAP HANA system replication for the instance.

Members
ClusterStatus
Type: string

The cluster status of the component.

EnqueueReplication
Type: boolean

Indicates if or not enqueue replication is enabled for the ASCS component.

HsrOperationMode
Type: string

The operation mode of the component.

HsrReplicationMode
Type: string

The replication mode of the component.

HsrTier
Type: string

The tier of the component.

Resource

Description

The resource contains a ResourceArn and the ResourceType.

Members
ResourceArn
Type: string

The Amazon Resource Name (ARN) of the source resource.

Example of ResourceArn: "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321"

ResourceType
Type: string

The resource type.

Example of ResourceType: "AWS::SystemsManagerSAP::Component" or "AWS::EC2::Instance".

ResourceNotFoundException

Description

The resource is not available.

Members
Message
Type: string

UnauthorizedException

Description

The request is not authorized.

Members
Message
Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an AWS service.

Members
Message
Type: string