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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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.