ssmsap/aws.sdk.kotlin.services.ssmsap

Package-level declarations

Types

This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

deleteResourcePermission

inline suspend fun SsmSapClient.deleteResourcePermission(crossinline block: DeleteResourcePermissionRequest.Builder.() -> Unit): DeleteResourcePermissionResponse

Removes permissions associated with the target database.

deregisterApplication

inline suspend fun SsmSapClient.deregisterApplication(crossinline block: DeregisterApplicationRequest.Builder.() -> Unit): DeregisterApplicationResponse

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

getApplication

inline suspend fun SsmSapClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse

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

getComponent

inline suspend fun SsmSapClient.getComponent(crossinline block: GetComponentRequest.Builder.() -> Unit): GetComponentResponse

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

getDatabase

inline suspend fun SsmSapClient.getDatabase(crossinline block: GetDatabaseRequest.Builder.() -> Unit): GetDatabaseResponse

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

getOperation

inline suspend fun SsmSapClient.getOperation(crossinline block: GetOperationRequest.Builder.() -> Unit): GetOperationResponse

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

getResourcePermission

inline suspend fun SsmSapClient.getResourcePermission(crossinline block: GetResourcePermissionRequest.Builder.() -> Unit): GetResourcePermissionResponse

Gets permissions associated with the target database.

listApplications

inline suspend fun SsmSapClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse

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

listComponents

inline suspend fun SsmSapClient.listComponents(crossinline block: ListComponentsRequest.Builder.() -> Unit): ListComponentsResponse

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

listDatabases

inline suspend fun SsmSapClient.listDatabases(crossinline block: ListDatabasesRequest.Builder.() -> Unit): ListDatabasesResponse

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

listOperationEvents

inline suspend fun SsmSapClient.listOperationEvents(crossinline block: ListOperationEventsRequest.Builder.() -> Unit): ListOperationEventsResponse

Returns a list of operations events.

listOperations

inline suspend fun SsmSapClient.listOperations(crossinline block: ListOperationsRequest.Builder.() -> Unit): ListOperationsResponse

Lists the operations performed by AWS Systems Manager for SAP.

listTagsForResource

inline suspend fun SsmSapClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

putResourcePermission

inline suspend fun SsmSapClient.putResourcePermission(crossinline block: PutResourcePermissionRequest.Builder.() -> Unit): PutResourcePermissionResponse

Adds permissions to the target database.

registerApplication

inline suspend fun SsmSapClient.registerApplication(crossinline block: RegisterApplicationRequest.Builder.() -> Unit): RegisterApplicationResponse

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

startApplication

inline suspend fun SsmSapClient.startApplication(crossinline block: StartApplicationRequest.Builder.() -> Unit): StartApplicationResponse

Request is an operation which starts an application.

startApplicationRefresh

inline suspend fun SsmSapClient.startApplicationRefresh(crossinline block: StartApplicationRefreshRequest.Builder.() -> Unit): StartApplicationRefreshResponse

Refreshes a registered application.

stopApplication

inline suspend fun SsmSapClient.stopApplication(crossinline block: StopApplicationRequest.Builder.() -> Unit): StopApplicationResponse

Request is an operation to stop an application.

tagResource

inline suspend fun SsmSapClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Creates tag for a resource by specifying the ARN.

untagResource

inline suspend fun SsmSapClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Delete the tags for a resource.

updateApplicationSettings

inline suspend fun SsmSapClient.updateApplicationSettings(crossinline block: UpdateApplicationSettingsRequest.Builder.() -> Unit): UpdateApplicationSettingsResponse

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

withConfig

fun SsmSapClient.withConfig(block: SsmSapClient.Config.Builder.() -> Unit): SsmSapClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.