commonMain.aws.sdk.kotlin.services.ssmsap.SsmSapClient.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.ssmsap
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.http.retries.AwsDefaultRetryPolicy
import aws.sdk.kotlin.services.ssmsap.endpoints.DefaultEndpointProvider
import aws.sdk.kotlin.services.ssmsap.endpoints.EndpointParameters
import aws.sdk.kotlin.services.ssmsap.endpoints.EndpointProvider
import aws.sdk.kotlin.services.ssmsap.model.DeleteResourcePermissionRequest
import aws.sdk.kotlin.services.ssmsap.model.DeleteResourcePermissionResponse
import aws.sdk.kotlin.services.ssmsap.model.DeregisterApplicationRequest
import aws.sdk.kotlin.services.ssmsap.model.DeregisterApplicationResponse
import aws.sdk.kotlin.services.ssmsap.model.GetApplicationRequest
import aws.sdk.kotlin.services.ssmsap.model.GetApplicationResponse
import aws.sdk.kotlin.services.ssmsap.model.GetComponentRequest
import aws.sdk.kotlin.services.ssmsap.model.GetComponentResponse
import aws.sdk.kotlin.services.ssmsap.model.GetDatabaseRequest
import aws.sdk.kotlin.services.ssmsap.model.GetDatabaseResponse
import aws.sdk.kotlin.services.ssmsap.model.GetOperationRequest
import aws.sdk.kotlin.services.ssmsap.model.GetOperationResponse
import aws.sdk.kotlin.services.ssmsap.model.GetResourcePermissionRequest
import aws.sdk.kotlin.services.ssmsap.model.GetResourcePermissionResponse
import aws.sdk.kotlin.services.ssmsap.model.ListApplicationsRequest
import aws.sdk.kotlin.services.ssmsap.model.ListApplicationsResponse
import aws.sdk.kotlin.services.ssmsap.model.ListComponentsRequest
import aws.sdk.kotlin.services.ssmsap.model.ListComponentsResponse
import aws.sdk.kotlin.services.ssmsap.model.ListDatabasesRequest
import aws.sdk.kotlin.services.ssmsap.model.ListDatabasesResponse
import aws.sdk.kotlin.services.ssmsap.model.ListOperationsRequest
import aws.sdk.kotlin.services.ssmsap.model.ListOperationsResponse
import aws.sdk.kotlin.services.ssmsap.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.ssmsap.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.ssmsap.model.PutResourcePermissionRequest
import aws.sdk.kotlin.services.ssmsap.model.PutResourcePermissionResponse
import aws.sdk.kotlin.services.ssmsap.model.RegisterApplicationRequest
import aws.sdk.kotlin.services.ssmsap.model.RegisterApplicationResponse
import aws.sdk.kotlin.services.ssmsap.model.TagResourceRequest
import aws.sdk.kotlin.services.ssmsap.model.TagResourceResponse
import aws.sdk.kotlin.services.ssmsap.model.UntagResourceRequest
import aws.sdk.kotlin.services.ssmsap.model.UntagResourceResponse
import aws.sdk.kotlin.services.ssmsap.model.UpdateApplicationSettingsRequest
import aws.sdk.kotlin.services.ssmsap.model.UpdateApplicationSettingsResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.client.SdkClientFactory
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.auth.HttpAuthScheme
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.StandardRetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.tracing.DefaultTracer
import aws.smithy.kotlin.runtime.tracing.LoggingTraceProbe
import aws.smithy.kotlin.runtime.tracing.Tracer
import aws.smithy.kotlin.runtime.tracing.TracingClientConfig
import kotlin.collections.List
import kotlin.jvm.JvmStatic
/**
* 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.
*/
public interface SsmSapClient : SdkClient {
/**
* SsmSapClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory() {
@JvmStatic
override fun builder(): Builder = Builder()
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): SsmSapClient = DefaultSsmSapClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), SdkClientConfig, TracingClientConfig {
override val clientName: String = builder.clientName
override val region: String = requireNotNull(builder.region) { "region is a required configuration property" }
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: EndpointProvider = builder.endpointProvider ?: DefaultEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsDefaultRetryPolicy
override val retryStrategy: RetryStrategy = builder.retryStrategy ?: StandardRetryStrategy()
override val tracer: Tracer = builder.tracer ?: DefaultTracer(LoggingTraceProbe, clientName)
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
tracer = [email protected]
useDualStack = [email protected]
useFips = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TracingClientConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "Ssm Sap"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [HttpAuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: EndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The [RetryStrategy] implementation to use for service calls. All API calls will be wrapped by the
* strategy.
*/
override var retryStrategy: RetryStrategy? = null
/**
* The tracer that is responsible for creating trace spans and wiring them up to a tracing backend (e.g.,
* a trace probe). By default, this will create a standard tracer that uses the service name for the root
* trace span and delegates to a logging trace probe (i.e.,
* `DefaultTracer(LoggingTraceProbe, "")`).
*/
override var tracer: Tracer? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
override fun build(): Config = Config(this)
}
}
/**
* Removes permissions associated with the target database.
*/
public suspend fun deleteResourcePermission(input: DeleteResourcePermissionRequest): DeleteResourcePermissionResponse
/**
* 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.
*/
public suspend fun deregisterApplication(input: DeregisterApplicationRequest): DeregisterApplicationResponse
/**
* Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
*/
public suspend fun getApplication(input: GetApplicationRequest = GetApplicationRequest {}): GetApplicationResponse
/**
* Gets the component of an application registered with AWS Systems Manager for SAP.
*/
public suspend fun getComponent(input: GetComponentRequest): GetComponentResponse
/**
* Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
*/
public suspend fun getDatabase(input: GetDatabaseRequest = GetDatabaseRequest {}): GetDatabaseResponse
/**
* Gets the details of an operation by specifying the operation ID.
*/
public suspend fun getOperation(input: GetOperationRequest): GetOperationResponse
/**
* Gets permissions associated with the target database.
*/
public suspend fun getResourcePermission(input: GetResourcePermissionRequest): GetResourcePermissionResponse
/**
* Lists all the applications registered with AWS Systems Manager for SAP.
*/
public suspend fun listApplications(input: ListApplicationsRequest = ListApplicationsRequest {}): ListApplicationsResponse
/**
* Lists all the components registered with AWS Systems Manager for SAP.
*/
public suspend fun listComponents(input: ListComponentsRequest = ListComponentsRequest {}): ListComponentsResponse
/**
* Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
*/
public suspend fun listDatabases(input: ListDatabasesRequest = ListDatabasesRequest {}): ListDatabasesResponse
/**
* Lists the operations performed by AWS Systems Manager for SAP.
*/
public suspend fun listOperations(input: ListOperationsRequest): ListOperationsResponse
/**
* Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Adds permissions to the target database.
*/
public suspend fun putResourcePermission(input: PutResourcePermissionRequest): PutResourcePermissionResponse
/**
* 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.
*/
public suspend fun registerApplication(input: RegisterApplicationRequest): RegisterApplicationResponse
/**
* Creates tag for a resource by specifying the ARN.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Delete the tags for a resource.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
/**
* Updates the settings of an application registered with AWS Systems Manager for SAP.
*/
public suspend fun updateApplicationSettings(input: UpdateApplicationSettingsRequest): UpdateApplicationSettingsResponse
}
/**
* 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.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun SsmSapClient.withConfig(block: SsmSapClient.Config.Builder.() -> Unit): SsmSapClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultSsmSapClient(newConfig)
}
/**
* Removes permissions associated with the target database.
*/
public suspend inline fun SsmSapClient.deleteResourcePermission(crossinline block: DeleteResourcePermissionRequest.Builder.() -> Unit): DeleteResourcePermissionResponse = deleteResourcePermission(DeleteResourcePermissionRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun SsmSapClient.deregisterApplication(crossinline block: DeregisterApplicationRequest.Builder.() -> Unit): DeregisterApplicationResponse = deregisterApplication(DeregisterApplicationRequest.Builder().apply(block).build())
/**
* Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
*/
public suspend inline fun SsmSapClient.getApplication(crossinline block: GetApplicationRequest.Builder.() -> Unit): GetApplicationResponse = getApplication(GetApplicationRequest.Builder().apply(block).build())
/**
* Gets the component of an application registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.getComponent(crossinline block: GetComponentRequest.Builder.() -> Unit): GetComponentResponse = getComponent(GetComponentRequest.Builder().apply(block).build())
/**
* Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.getDatabase(crossinline block: GetDatabaseRequest.Builder.() -> Unit): GetDatabaseResponse = getDatabase(GetDatabaseRequest.Builder().apply(block).build())
/**
* Gets the details of an operation by specifying the operation ID.
*/
public suspend inline fun SsmSapClient.getOperation(crossinline block: GetOperationRequest.Builder.() -> Unit): GetOperationResponse = getOperation(GetOperationRequest.Builder().apply(block).build())
/**
* Gets permissions associated with the target database.
*/
public suspend inline fun SsmSapClient.getResourcePermission(crossinline block: GetResourcePermissionRequest.Builder.() -> Unit): GetResourcePermissionResponse = getResourcePermission(GetResourcePermissionRequest.Builder().apply(block).build())
/**
* Lists all the applications registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.listApplications(crossinline block: ListApplicationsRequest.Builder.() -> Unit): ListApplicationsResponse = listApplications(ListApplicationsRequest.Builder().apply(block).build())
/**
* Lists all the components registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.listComponents(crossinline block: ListComponentsRequest.Builder.() -> Unit): ListComponentsResponse = listComponents(ListComponentsRequest.Builder().apply(block).build())
/**
* Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.listDatabases(crossinline block: ListDatabasesRequest.Builder.() -> Unit): ListDatabasesResponse = listDatabases(ListDatabasesRequest.Builder().apply(block).build())
/**
* Lists the operations performed by AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.listOperations(crossinline block: ListOperationsRequest.Builder.() -> Unit): ListOperationsResponse = listOperations(ListOperationsRequest.Builder().apply(block).build())
/**
* Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Adds permissions to the target database.
*/
public suspend inline fun SsmSapClient.putResourcePermission(crossinline block: PutResourcePermissionRequest.Builder.() -> Unit): PutResourcePermissionResponse = putResourcePermission(PutResourcePermissionRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun SsmSapClient.registerApplication(crossinline block: RegisterApplicationRequest.Builder.() -> Unit): RegisterApplicationResponse = registerApplication(RegisterApplicationRequest.Builder().apply(block).build())
/**
* Creates tag for a resource by specifying the ARN.
*/
public suspend inline fun SsmSapClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Delete the tags for a resource.
*/
public suspend inline fun SsmSapClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
/**
* Updates the settings of an application registered with AWS Systems Manager for SAP.
*/
public suspend inline fun SsmSapClient.updateApplicationSettings(crossinline block: UpdateApplicationSettingsRequest.Builder.() -> Unit): UpdateApplicationSettingsResponse = updateApplicationSettings(UpdateApplicationSettingsRequest.Builder().apply(block).build())
© 2015 - 2025 Weber Informatics LLC | Privacy Policy