commonMain.aws.sdk.kotlin.services.nimble.NimbleClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nimble-jvm Show documentation
Show all versions of nimble-jvm Show documentation
The AWS SDK for Kotlin client for nimble
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.nimble
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.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.nimble.auth.DefaultNimbleAuthSchemeProvider
import aws.sdk.kotlin.services.nimble.auth.NimbleAuthSchemeProvider
import aws.sdk.kotlin.services.nimble.endpoints.DefaultNimbleEndpointProvider
import aws.sdk.kotlin.services.nimble.endpoints.NimbleEndpointParameters
import aws.sdk.kotlin.services.nimble.endpoints.NimbleEndpointProvider
import aws.sdk.kotlin.services.nimble.model.AcceptEulasRequest
import aws.sdk.kotlin.services.nimble.model.AcceptEulasResponse
import aws.sdk.kotlin.services.nimble.model.CreateLaunchProfileRequest
import aws.sdk.kotlin.services.nimble.model.CreateLaunchProfileResponse
import aws.sdk.kotlin.services.nimble.model.CreateStreamingImageRequest
import aws.sdk.kotlin.services.nimble.model.CreateStreamingImageResponse
import aws.sdk.kotlin.services.nimble.model.CreateStreamingSessionRequest
import aws.sdk.kotlin.services.nimble.model.CreateStreamingSessionResponse
import aws.sdk.kotlin.services.nimble.model.CreateStreamingSessionStreamRequest
import aws.sdk.kotlin.services.nimble.model.CreateStreamingSessionStreamResponse
import aws.sdk.kotlin.services.nimble.model.CreateStudioComponentRequest
import aws.sdk.kotlin.services.nimble.model.CreateStudioComponentResponse
import aws.sdk.kotlin.services.nimble.model.CreateStudioRequest
import aws.sdk.kotlin.services.nimble.model.CreateStudioResponse
import aws.sdk.kotlin.services.nimble.model.DeleteLaunchProfileMemberRequest
import aws.sdk.kotlin.services.nimble.model.DeleteLaunchProfileMemberResponse
import aws.sdk.kotlin.services.nimble.model.DeleteLaunchProfileRequest
import aws.sdk.kotlin.services.nimble.model.DeleteLaunchProfileResponse
import aws.sdk.kotlin.services.nimble.model.DeleteStreamingImageRequest
import aws.sdk.kotlin.services.nimble.model.DeleteStreamingImageResponse
import aws.sdk.kotlin.services.nimble.model.DeleteStreamingSessionRequest
import aws.sdk.kotlin.services.nimble.model.DeleteStreamingSessionResponse
import aws.sdk.kotlin.services.nimble.model.DeleteStudioComponentRequest
import aws.sdk.kotlin.services.nimble.model.DeleteStudioComponentResponse
import aws.sdk.kotlin.services.nimble.model.DeleteStudioMemberRequest
import aws.sdk.kotlin.services.nimble.model.DeleteStudioMemberResponse
import aws.sdk.kotlin.services.nimble.model.DeleteStudioRequest
import aws.sdk.kotlin.services.nimble.model.DeleteStudioResponse
import aws.sdk.kotlin.services.nimble.model.GetEulaRequest
import aws.sdk.kotlin.services.nimble.model.GetEulaResponse
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileDetailsRequest
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileDetailsResponse
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileInitializationRequest
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileInitializationResponse
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileMemberRequest
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileMemberResponse
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileRequest
import aws.sdk.kotlin.services.nimble.model.GetLaunchProfileResponse
import aws.sdk.kotlin.services.nimble.model.GetStreamingImageRequest
import aws.sdk.kotlin.services.nimble.model.GetStreamingImageResponse
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionBackupRequest
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionBackupResponse
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionRequest
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionResponse
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionStreamRequest
import aws.sdk.kotlin.services.nimble.model.GetStreamingSessionStreamResponse
import aws.sdk.kotlin.services.nimble.model.GetStudioComponentRequest
import aws.sdk.kotlin.services.nimble.model.GetStudioComponentResponse
import aws.sdk.kotlin.services.nimble.model.GetStudioMemberRequest
import aws.sdk.kotlin.services.nimble.model.GetStudioMemberResponse
import aws.sdk.kotlin.services.nimble.model.GetStudioRequest
import aws.sdk.kotlin.services.nimble.model.GetStudioResponse
import aws.sdk.kotlin.services.nimble.model.ListEulaAcceptancesRequest
import aws.sdk.kotlin.services.nimble.model.ListEulaAcceptancesResponse
import aws.sdk.kotlin.services.nimble.model.ListEulasRequest
import aws.sdk.kotlin.services.nimble.model.ListEulasResponse
import aws.sdk.kotlin.services.nimble.model.ListLaunchProfileMembersRequest
import aws.sdk.kotlin.services.nimble.model.ListLaunchProfileMembersResponse
import aws.sdk.kotlin.services.nimble.model.ListLaunchProfilesRequest
import aws.sdk.kotlin.services.nimble.model.ListLaunchProfilesResponse
import aws.sdk.kotlin.services.nimble.model.ListStreamingImagesRequest
import aws.sdk.kotlin.services.nimble.model.ListStreamingImagesResponse
import aws.sdk.kotlin.services.nimble.model.ListStreamingSessionBackupsRequest
import aws.sdk.kotlin.services.nimble.model.ListStreamingSessionBackupsResponse
import aws.sdk.kotlin.services.nimble.model.ListStreamingSessionsRequest
import aws.sdk.kotlin.services.nimble.model.ListStreamingSessionsResponse
import aws.sdk.kotlin.services.nimble.model.ListStudioComponentsRequest
import aws.sdk.kotlin.services.nimble.model.ListStudioComponentsResponse
import aws.sdk.kotlin.services.nimble.model.ListStudioMembersRequest
import aws.sdk.kotlin.services.nimble.model.ListStudioMembersResponse
import aws.sdk.kotlin.services.nimble.model.ListStudiosRequest
import aws.sdk.kotlin.services.nimble.model.ListStudiosResponse
import aws.sdk.kotlin.services.nimble.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.nimble.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.nimble.model.PutLaunchProfileMembersRequest
import aws.sdk.kotlin.services.nimble.model.PutLaunchProfileMembersResponse
import aws.sdk.kotlin.services.nimble.model.PutStudioMembersRequest
import aws.sdk.kotlin.services.nimble.model.PutStudioMembersResponse
import aws.sdk.kotlin.services.nimble.model.StartStreamingSessionRequest
import aws.sdk.kotlin.services.nimble.model.StartStreamingSessionResponse
import aws.sdk.kotlin.services.nimble.model.StartStudioSsoConfigurationRepairRequest
import aws.sdk.kotlin.services.nimble.model.StartStudioSsoConfigurationRepairResponse
import aws.sdk.kotlin.services.nimble.model.StopStreamingSessionRequest
import aws.sdk.kotlin.services.nimble.model.StopStreamingSessionResponse
import aws.sdk.kotlin.services.nimble.model.TagResourceRequest
import aws.sdk.kotlin.services.nimble.model.TagResourceResponse
import aws.sdk.kotlin.services.nimble.model.UntagResourceRequest
import aws.sdk.kotlin.services.nimble.model.UntagResourceResponse
import aws.sdk.kotlin.services.nimble.model.UpdateLaunchProfileMemberRequest
import aws.sdk.kotlin.services.nimble.model.UpdateLaunchProfileMemberResponse
import aws.sdk.kotlin.services.nimble.model.UpdateLaunchProfileRequest
import aws.sdk.kotlin.services.nimble.model.UpdateLaunchProfileResponse
import aws.sdk.kotlin.services.nimble.model.UpdateStreamingImageRequest
import aws.sdk.kotlin.services.nimble.model.UpdateStreamingImageResponse
import aws.sdk.kotlin.services.nimble.model.UpdateStudioComponentRequest
import aws.sdk.kotlin.services.nimble.model.UpdateStudioComponentResponse
import aws.sdk.kotlin.services.nimble.model.UpdateStudioRequest
import aws.sdk.kotlin.services.nimble.model.UpdateStudioResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.IdempotencyTokenConfig
import aws.smithy.kotlin.runtime.client.IdempotencyTokenProvider
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
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.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "nimble"
public const val SdkVersion: String = "1.3.63"
public const val ServiceApiVersion: String = "2020-08-01"
/**
* Welcome to the Amazon Nimble Studio API reference. This API reference provides methods, schema, resources, parameters, and more to help you get the most out of Nimble Studio.
*
* Nimble Studio is a virtual studio that empowers visual effects, animation, and interactive content teams to create content securely within a scalable, private cloud service.
*/
public interface NimbleClient : SdkClient {
/**
* NimbleClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory()
{
@JvmStatic
override fun builder(): Builder = Builder()
override fun finalizeConfig(builder: Builder) {
super.finalizeConfig(builder)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"Nimble",
"NIMBLE",
"nimble",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): NimbleClient = DefaultNimbleClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: NimbleEndpointProvider = builder.endpointProvider ?: DefaultNimbleEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val idempotencyTokenProvider: IdempotencyTokenProvider = builder.idempotencyTokenProvider ?: IdempotencyTokenProvider.Default
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: NimbleAuthSchemeProvider = builder.authSchemeProvider ?: DefaultNimbleAuthSchemeProvider()
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]
idempotencyTokenProvider = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), IdempotencyTokenConfig.Builder, RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "nimble"
/**
* 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 [AuthScheme]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: NimbleEndpointProvider? = 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
/**
* Override the default idempotency token generator. SDK clients will generate tokens for members
* that represent idempotent tokens when not explicitly set by the caller using this generator.
*/
override var idempotencyTokenProvider: IdempotencyTokenProvider? = 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 telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = 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
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: NimbleAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* Accept EULAs.
*/
public suspend fun acceptEulas(input: AcceptEulasRequest): AcceptEulasResponse
/**
* Create a launch profile.
*/
public suspend fun createLaunchProfile(input: CreateLaunchProfileRequest): CreateLaunchProfileResponse
/**
* Creates a streaming image resource in a studio.
*/
public suspend fun createStreamingImage(input: CreateStreamingImageRequest): CreateStreamingImageResponse
/**
* Creates a streaming session in a studio.
*
* After invoking this operation, you must poll GetStreamingSession until the streaming session is in the `READY` state.
*/
public suspend fun createStreamingSession(input: CreateStreamingSessionRequest): CreateStreamingSessionResponse
/**
* Creates a streaming session stream for a streaming session.
*
* After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the `READY` state.
*/
public suspend fun createStreamingSessionStream(input: CreateStreamingSessionStreamRequest): CreateStreamingSessionStreamResponse
/**
* Create a new studio.
*
* When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
*
* The user role must have the `AmazonNimbleStudio-StudioUser` managed policy attached for the portal to function properly.
*
* The admin role must have the `AmazonNimbleStudio-StudioAdmin` managed policy attached for the portal to function properly.
*
* You may optionally specify a KMS key in the `StudioEncryptionConfiguration`.
*
* In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling `CreateStudio` to encrypt this data using a key you own and manage.
*
* When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
*
* If you delete this grant, the studio will no longer be accessible to your portal users.
*
* If you delete the studio KMS key, your studio will no longer be accessible.
*/
public suspend fun createStudio(input: CreateStudioRequest): CreateStudioResponse
/**
* Creates a studio component resource.
*/
public suspend fun createStudioComponent(input: CreateStudioComponentRequest): CreateStudioComponentResponse
/**
* Permanently delete a launch profile.
*/
public suspend fun deleteLaunchProfile(input: DeleteLaunchProfileRequest): DeleteLaunchProfileResponse
/**
* Delete a user from launch profile membership.
*/
public suspend fun deleteLaunchProfileMember(input: DeleteLaunchProfileMemberRequest): DeleteLaunchProfileMemberResponse
/**
* Delete streaming image.
*/
public suspend fun deleteStreamingImage(input: DeleteStreamingImageRequest): DeleteStreamingImageResponse
/**
* Deletes streaming session resource.
*
* After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a `DELETED` state.
*
* A streaming session will count against your streaming session quota until it is marked `DELETED`.
*/
public suspend fun deleteStreamingSession(input: DeleteStreamingSessionRequest): DeleteStreamingSessionResponse
/**
* Delete a studio resource.
*/
public suspend fun deleteStudio(input: DeleteStudioRequest): DeleteStudioResponse
/**
* Deletes a studio component resource.
*/
public suspend fun deleteStudioComponent(input: DeleteStudioComponentRequest): DeleteStudioComponentResponse
/**
* Delete a user from studio membership.
*/
public suspend fun deleteStudioMember(input: DeleteStudioMemberRequest): DeleteStudioMemberResponse
/**
* Get EULA.
*/
public suspend fun getEula(input: GetEulaRequest): GetEulaResponse
/**
* Get a launch profile.
*/
public suspend fun getLaunchProfile(input: GetLaunchProfileRequest): GetLaunchProfileResponse
/**
* Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
*/
public suspend fun getLaunchProfileDetails(input: GetLaunchProfileDetailsRequest): GetLaunchProfileDetailsResponse
/**
* Get a launch profile initialization.
*/
public suspend fun getLaunchProfileInitialization(input: GetLaunchProfileInitializationRequest): GetLaunchProfileInitializationResponse
/**
* Get a user persona in launch profile membership.
*/
public suspend fun getLaunchProfileMember(input: GetLaunchProfileMemberRequest): GetLaunchProfileMemberResponse
/**
* Get streaming image.
*/
public suspend fun getStreamingImage(input: GetStreamingImageRequest): GetStreamingImageResponse
/**
* Gets StreamingSession resource.
*
* Invoke this operation to poll for a streaming session state while creating or deleting a session.
*/
public suspend fun getStreamingSession(input: GetStreamingSessionRequest): GetStreamingSessionResponse
/**
* Gets `StreamingSessionBackup` resource.
*
* Invoke this operation to poll for a streaming session backup while stopping a streaming session.
*/
public suspend fun getStreamingSessionBackup(input: GetStreamingSessionBackupRequest): GetStreamingSessionBackupResponse
/**
* Gets a StreamingSessionStream for a streaming session.
*
* Invoke this operation to poll the resource after invoking `CreateStreamingSessionStream`.
*
* After the `StreamingSessionStream` changes to the `READY` state, the url property will contain a stream to be used with the DCV streaming client.
*/
public suspend fun getStreamingSessionStream(input: GetStreamingSessionStreamRequest): GetStreamingSessionStreamResponse
/**
* Get a studio resource.
*/
public suspend fun getStudio(input: GetStudioRequest): GetStudioResponse
/**
* Gets a studio component resource.
*/
public suspend fun getStudioComponent(input: GetStudioComponentRequest): GetStudioComponentResponse
/**
* Get a user's membership in a studio.
*/
public suspend fun getStudioMember(input: GetStudioMemberRequest): GetStudioMemberResponse
/**
* List EULA acceptances.
*/
public suspend fun listEulaAcceptances(input: ListEulaAcceptancesRequest): ListEulaAcceptancesResponse
/**
* List EULAs.
*/
public suspend fun listEulas(input: ListEulasRequest = ListEulasRequest { }): ListEulasResponse
/**
* Get all users in a given launch profile membership.
*/
public suspend fun listLaunchProfileMembers(input: ListLaunchProfileMembersRequest): ListLaunchProfileMembersResponse
/**
* List all the launch profiles a studio.
*/
public suspend fun listLaunchProfiles(input: ListLaunchProfilesRequest): ListLaunchProfilesResponse
/**
* List the streaming image resources available to this studio.
*
* This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
*/
public suspend fun listStreamingImages(input: ListStreamingImagesRequest): ListStreamingImagesResponse
/**
* Lists the backups of a streaming session in a studio.
*/
public suspend fun listStreamingSessionBackups(input: ListStreamingSessionBackupsRequest): ListStreamingSessionBackupsResponse
/**
* Lists the streaming sessions in a studio.
*/
public suspend fun listStreamingSessions(input: ListStreamingSessionsRequest): ListStreamingSessionsResponse
/**
* Lists the `StudioComponents` in a studio.
*/
public suspend fun listStudioComponents(input: ListStudioComponentsRequest): ListStudioComponentsResponse
/**
* Get all users in a given studio membership.
*
* `ListStudioMembers` only returns admin members.
*/
public suspend fun listStudioMembers(input: ListStudioMembersRequest): ListStudioMembersResponse
/**
* List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
*/
public suspend fun listStudios(input: ListStudiosRequest = ListStudiosRequest { }): ListStudiosResponse
/**
* Gets the tags for a resource, given its Amazon Resource Names (ARN).
*
* This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* Add/update users with given persona to launch profile membership.
*/
public suspend fun putLaunchProfileMembers(input: PutLaunchProfileMembersRequest): PutLaunchProfileMembersResponse
/**
* Add/update users with given persona to studio membership.
*/
public suspend fun putStudioMembers(input: PutStudioMembersRequest): PutStudioMembersResponse
/**
* Transitions sessions from the `STOPPED` state into the `READY` state. The `START_IN_PROGRESS` state is the intermediate state between the `STOPPED` and `READY` states.
*/
public suspend fun startStreamingSession(input: StartStreamingSessionRequest): StartStreamingSessionResponse
/**
* Repairs the IAM Identity Center configuration for a given studio.
*
* If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
*
* If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the `READY` state.
*
* After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
*/
public suspend fun startStudioSsoConfigurationRepair(input: StartStudioSsoConfigurationRepairRequest): StartStudioSsoConfigurationRepairResponse
/**
* Transitions sessions from the `READY` state into the `STOPPED` state. The `STOP_IN_PROGRESS` state is the intermediate state between the `READY` and `STOPPED` states.
*/
public suspend fun stopStreamingSession(input: StopStreamingSessionRequest): StopStreamingSessionResponse
/**
* Creates tags for a resource, given its ARN.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Deletes the tags for a resource.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
/**
* Update a launch profile.
*/
public suspend fun updateLaunchProfile(input: UpdateLaunchProfileRequest): UpdateLaunchProfileResponse
/**
* Update a user persona in launch profile membership.
*/
public suspend fun updateLaunchProfileMember(input: UpdateLaunchProfileMemberRequest): UpdateLaunchProfileMemberResponse
/**
* Update streaming image.
*/
public suspend fun updateStreamingImage(input: UpdateStreamingImageRequest): UpdateStreamingImageResponse
/**
* Update a Studio resource.
*
* Currently, this operation only supports updating the displayName of your studio.
*/
public suspend fun updateStudio(input: UpdateStudioRequest): UpdateStudioResponse
/**
* Updates a studio component resource.
*/
public suspend fun updateStudioComponent(input: UpdateStudioComponentRequest): UpdateStudioComponentResponse
}
/**
* 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 NimbleClient.withConfig(block: NimbleClient.Config.Builder.() -> Unit): NimbleClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultNimbleClient(newConfig)
}
/**
* Accept EULAs.
*/
public suspend inline fun NimbleClient.acceptEulas(crossinline block: AcceptEulasRequest.Builder.() -> Unit): AcceptEulasResponse = acceptEulas(AcceptEulasRequest.Builder().apply(block).build())
/**
* Create a launch profile.
*/
public suspend inline fun NimbleClient.createLaunchProfile(crossinline block: CreateLaunchProfileRequest.Builder.() -> Unit): CreateLaunchProfileResponse = createLaunchProfile(CreateLaunchProfileRequest.Builder().apply(block).build())
/**
* Creates a streaming image resource in a studio.
*/
public suspend inline fun NimbleClient.createStreamingImage(crossinline block: CreateStreamingImageRequest.Builder.() -> Unit): CreateStreamingImageResponse = createStreamingImage(CreateStreamingImageRequest.Builder().apply(block).build())
/**
* Creates a streaming session in a studio.
*
* After invoking this operation, you must poll GetStreamingSession until the streaming session is in the `READY` state.
*/
public suspend inline fun NimbleClient.createStreamingSession(crossinline block: CreateStreamingSessionRequest.Builder.() -> Unit): CreateStreamingSessionResponse = createStreamingSession(CreateStreamingSessionRequest.Builder().apply(block).build())
/**
* Creates a streaming session stream for a streaming session.
*
* After invoking this API, invoke GetStreamingSessionStream with the returned streamId to poll the resource until it is in the `READY` state.
*/
public suspend inline fun NimbleClient.createStreamingSessionStream(crossinline block: CreateStreamingSessionStreamRequest.Builder.() -> Unit): CreateStreamingSessionStreamResponse = createStreamingSessionStream(CreateStreamingSessionStreamRequest.Builder().apply(block).build())
/**
* Create a new studio.
*
* When creating a studio, two IAM roles must be provided: the admin role and the user role. These roles are assumed by your users when they log in to the Nimble Studio portal.
*
* The user role must have the `AmazonNimbleStudio-StudioUser` managed policy attached for the portal to function properly.
*
* The admin role must have the `AmazonNimbleStudio-StudioAdmin` managed policy attached for the portal to function properly.
*
* You may optionally specify a KMS key in the `StudioEncryptionConfiguration`.
*
* In Nimble Studio, resource names, descriptions, initialization scripts, and other data you provide are always encrypted at rest using an KMS key. By default, this key is owned by Amazon Web Services and managed on your behalf. You may provide your own KMS key when calling `CreateStudio` to encrypt this data using a key you own and manage.
*
* When providing an KMS key during studio creation, Nimble Studio creates KMS grants in your account to provide your studio user and admin roles access to these KMS keys.
*
* If you delete this grant, the studio will no longer be accessible to your portal users.
*
* If you delete the studio KMS key, your studio will no longer be accessible.
*/
public suspend inline fun NimbleClient.createStudio(crossinline block: CreateStudioRequest.Builder.() -> Unit): CreateStudioResponse = createStudio(CreateStudioRequest.Builder().apply(block).build())
/**
* Creates a studio component resource.
*/
public suspend inline fun NimbleClient.createStudioComponent(crossinline block: CreateStudioComponentRequest.Builder.() -> Unit): CreateStudioComponentResponse = createStudioComponent(CreateStudioComponentRequest.Builder().apply(block).build())
/**
* Permanently delete a launch profile.
*/
public suspend inline fun NimbleClient.deleteLaunchProfile(crossinline block: DeleteLaunchProfileRequest.Builder.() -> Unit): DeleteLaunchProfileResponse = deleteLaunchProfile(DeleteLaunchProfileRequest.Builder().apply(block).build())
/**
* Delete a user from launch profile membership.
*/
public suspend inline fun NimbleClient.deleteLaunchProfileMember(crossinline block: DeleteLaunchProfileMemberRequest.Builder.() -> Unit): DeleteLaunchProfileMemberResponse = deleteLaunchProfileMember(DeleteLaunchProfileMemberRequest.Builder().apply(block).build())
/**
* Delete streaming image.
*/
public suspend inline fun NimbleClient.deleteStreamingImage(crossinline block: DeleteStreamingImageRequest.Builder.() -> Unit): DeleteStreamingImageResponse = deleteStreamingImage(DeleteStreamingImageRequest.Builder().apply(block).build())
/**
* Deletes streaming session resource.
*
* After invoking this operation, use GetStreamingSession to poll the resource until it transitions to a `DELETED` state.
*
* A streaming session will count against your streaming session quota until it is marked `DELETED`.
*/
public suspend inline fun NimbleClient.deleteStreamingSession(crossinline block: DeleteStreamingSessionRequest.Builder.() -> Unit): DeleteStreamingSessionResponse = deleteStreamingSession(DeleteStreamingSessionRequest.Builder().apply(block).build())
/**
* Delete a studio resource.
*/
public suspend inline fun NimbleClient.deleteStudio(crossinline block: DeleteStudioRequest.Builder.() -> Unit): DeleteStudioResponse = deleteStudio(DeleteStudioRequest.Builder().apply(block).build())
/**
* Deletes a studio component resource.
*/
public suspend inline fun NimbleClient.deleteStudioComponent(crossinline block: DeleteStudioComponentRequest.Builder.() -> Unit): DeleteStudioComponentResponse = deleteStudioComponent(DeleteStudioComponentRequest.Builder().apply(block).build())
/**
* Delete a user from studio membership.
*/
public suspend inline fun NimbleClient.deleteStudioMember(crossinline block: DeleteStudioMemberRequest.Builder.() -> Unit): DeleteStudioMemberResponse = deleteStudioMember(DeleteStudioMemberRequest.Builder().apply(block).build())
/**
* Get EULA.
*/
public suspend inline fun NimbleClient.getEula(crossinline block: GetEulaRequest.Builder.() -> Unit): GetEulaResponse = getEula(GetEulaRequest.Builder().apply(block).build())
/**
* Get a launch profile.
*/
public suspend inline fun NimbleClient.getLaunchProfile(crossinline block: GetLaunchProfileRequest.Builder.() -> Unit): GetLaunchProfileResponse = getLaunchProfile(GetLaunchProfileRequest.Builder().apply(block).build())
/**
* Launch profile details include the launch profile resource and summary information of resources that are used by, or available to, the launch profile. This includes the name and description of all studio components used by the launch profiles, and the name and description of streaming images that can be used with this launch profile.
*/
public suspend inline fun NimbleClient.getLaunchProfileDetails(crossinline block: GetLaunchProfileDetailsRequest.Builder.() -> Unit): GetLaunchProfileDetailsResponse = getLaunchProfileDetails(GetLaunchProfileDetailsRequest.Builder().apply(block).build())
/**
* Get a launch profile initialization.
*/
public suspend inline fun NimbleClient.getLaunchProfileInitialization(crossinline block: GetLaunchProfileInitializationRequest.Builder.() -> Unit): GetLaunchProfileInitializationResponse = getLaunchProfileInitialization(GetLaunchProfileInitializationRequest.Builder().apply(block).build())
/**
* Get a user persona in launch profile membership.
*/
public suspend inline fun NimbleClient.getLaunchProfileMember(crossinline block: GetLaunchProfileMemberRequest.Builder.() -> Unit): GetLaunchProfileMemberResponse = getLaunchProfileMember(GetLaunchProfileMemberRequest.Builder().apply(block).build())
/**
* Get streaming image.
*/
public suspend inline fun NimbleClient.getStreamingImage(crossinline block: GetStreamingImageRequest.Builder.() -> Unit): GetStreamingImageResponse = getStreamingImage(GetStreamingImageRequest.Builder().apply(block).build())
/**
* Gets StreamingSession resource.
*
* Invoke this operation to poll for a streaming session state while creating or deleting a session.
*/
public suspend inline fun NimbleClient.getStreamingSession(crossinline block: GetStreamingSessionRequest.Builder.() -> Unit): GetStreamingSessionResponse = getStreamingSession(GetStreamingSessionRequest.Builder().apply(block).build())
/**
* Gets `StreamingSessionBackup` resource.
*
* Invoke this operation to poll for a streaming session backup while stopping a streaming session.
*/
public suspend inline fun NimbleClient.getStreamingSessionBackup(crossinline block: GetStreamingSessionBackupRequest.Builder.() -> Unit): GetStreamingSessionBackupResponse = getStreamingSessionBackup(GetStreamingSessionBackupRequest.Builder().apply(block).build())
/**
* Gets a StreamingSessionStream for a streaming session.
*
* Invoke this operation to poll the resource after invoking `CreateStreamingSessionStream`.
*
* After the `StreamingSessionStream` changes to the `READY` state, the url property will contain a stream to be used with the DCV streaming client.
*/
public suspend inline fun NimbleClient.getStreamingSessionStream(crossinline block: GetStreamingSessionStreamRequest.Builder.() -> Unit): GetStreamingSessionStreamResponse = getStreamingSessionStream(GetStreamingSessionStreamRequest.Builder().apply(block).build())
/**
* Get a studio resource.
*/
public suspend inline fun NimbleClient.getStudio(crossinline block: GetStudioRequest.Builder.() -> Unit): GetStudioResponse = getStudio(GetStudioRequest.Builder().apply(block).build())
/**
* Gets a studio component resource.
*/
public suspend inline fun NimbleClient.getStudioComponent(crossinline block: GetStudioComponentRequest.Builder.() -> Unit): GetStudioComponentResponse = getStudioComponent(GetStudioComponentRequest.Builder().apply(block).build())
/**
* Get a user's membership in a studio.
*/
public suspend inline fun NimbleClient.getStudioMember(crossinline block: GetStudioMemberRequest.Builder.() -> Unit): GetStudioMemberResponse = getStudioMember(GetStudioMemberRequest.Builder().apply(block).build())
/**
* List EULA acceptances.
*/
public suspend inline fun NimbleClient.listEulaAcceptances(crossinline block: ListEulaAcceptancesRequest.Builder.() -> Unit): ListEulaAcceptancesResponse = listEulaAcceptances(ListEulaAcceptancesRequest.Builder().apply(block).build())
/**
* List EULAs.
*/
public suspend inline fun NimbleClient.listEulas(crossinline block: ListEulasRequest.Builder.() -> Unit): ListEulasResponse = listEulas(ListEulasRequest.Builder().apply(block).build())
/**
* Get all users in a given launch profile membership.
*/
public suspend inline fun NimbleClient.listLaunchProfileMembers(crossinline block: ListLaunchProfileMembersRequest.Builder.() -> Unit): ListLaunchProfileMembersResponse = listLaunchProfileMembers(ListLaunchProfileMembersRequest.Builder().apply(block).build())
/**
* List all the launch profiles a studio.
*/
public suspend inline fun NimbleClient.listLaunchProfiles(crossinline block: ListLaunchProfilesRequest.Builder.() -> Unit): ListLaunchProfilesResponse = listLaunchProfiles(ListLaunchProfilesRequest.Builder().apply(block).build())
/**
* List the streaming image resources available to this studio.
*
* This list will contain both images provided by Amazon Web Services, as well as streaming images that you have created in your studio.
*/
public suspend inline fun NimbleClient.listStreamingImages(crossinline block: ListStreamingImagesRequest.Builder.() -> Unit): ListStreamingImagesResponse = listStreamingImages(ListStreamingImagesRequest.Builder().apply(block).build())
/**
* Lists the backups of a streaming session in a studio.
*/
public suspend inline fun NimbleClient.listStreamingSessionBackups(crossinline block: ListStreamingSessionBackupsRequest.Builder.() -> Unit): ListStreamingSessionBackupsResponse = listStreamingSessionBackups(ListStreamingSessionBackupsRequest.Builder().apply(block).build())
/**
* Lists the streaming sessions in a studio.
*/
public suspend inline fun NimbleClient.listStreamingSessions(crossinline block: ListStreamingSessionsRequest.Builder.() -> Unit): ListStreamingSessionsResponse = listStreamingSessions(ListStreamingSessionsRequest.Builder().apply(block).build())
/**
* Lists the `StudioComponents` in a studio.
*/
public suspend inline fun NimbleClient.listStudioComponents(crossinline block: ListStudioComponentsRequest.Builder.() -> Unit): ListStudioComponentsResponse = listStudioComponents(ListStudioComponentsRequest.Builder().apply(block).build())
/**
* Get all users in a given studio membership.
*
* `ListStudioMembers` only returns admin members.
*/
public suspend inline fun NimbleClient.listStudioMembers(crossinline block: ListStudioMembersRequest.Builder.() -> Unit): ListStudioMembersResponse = listStudioMembers(ListStudioMembersRequest.Builder().apply(block).build())
/**
* List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.
*/
public suspend inline fun NimbleClient.listStudios(crossinline block: ListStudiosRequest.Builder.() -> Unit): ListStudiosResponse = listStudios(ListStudiosRequest.Builder().apply(block).build())
/**
* Gets the tags for a resource, given its Amazon Resource Names (ARN).
*
* This operation supports ARNs for all resource types in Nimble Studio that support tags, including studio, studio component, launch profile, streaming image, and streaming session. All resources that can be tagged will contain an ARN property, so you do not have to create this ARN yourself.
*/
public suspend inline fun NimbleClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* Add/update users with given persona to launch profile membership.
*/
public suspend inline fun NimbleClient.putLaunchProfileMembers(crossinline block: PutLaunchProfileMembersRequest.Builder.() -> Unit): PutLaunchProfileMembersResponse = putLaunchProfileMembers(PutLaunchProfileMembersRequest.Builder().apply(block).build())
/**
* Add/update users with given persona to studio membership.
*/
public suspend inline fun NimbleClient.putStudioMembers(crossinline block: PutStudioMembersRequest.Builder.() -> Unit): PutStudioMembersResponse = putStudioMembers(PutStudioMembersRequest.Builder().apply(block).build())
/**
* Transitions sessions from the `STOPPED` state into the `READY` state. The `START_IN_PROGRESS` state is the intermediate state between the `STOPPED` and `READY` states.
*/
public suspend inline fun NimbleClient.startStreamingSession(crossinline block: StartStreamingSessionRequest.Builder.() -> Unit): StartStreamingSessionResponse = startStreamingSession(StartStreamingSessionRequest.Builder().apply(block).build())
/**
* Repairs the IAM Identity Center configuration for a given studio.
*
* If the studio has a valid IAM Identity Center configuration currently associated with it, this operation will fail with a validation error.
*
* If the studio does not have a valid IAM Identity Center configuration currently associated with it, then a new IAM Identity Center application is created for the studio and the studio is changed to the `READY` state.
*
* After the IAM Identity Center application is repaired, you must use the Amazon Nimble Studio console to add administrators and users to your studio.
*/
public suspend inline fun NimbleClient.startStudioSsoConfigurationRepair(crossinline block: StartStudioSsoConfigurationRepairRequest.Builder.() -> Unit): StartStudioSsoConfigurationRepairResponse = startStudioSsoConfigurationRepair(StartStudioSsoConfigurationRepairRequest.Builder().apply(block).build())
/**
* Transitions sessions from the `READY` state into the `STOPPED` state. The `STOP_IN_PROGRESS` state is the intermediate state between the `READY` and `STOPPED` states.
*/
public suspend inline fun NimbleClient.stopStreamingSession(crossinline block: StopStreamingSessionRequest.Builder.() -> Unit): StopStreamingSessionResponse = stopStreamingSession(StopStreamingSessionRequest.Builder().apply(block).build())
/**
* Creates tags for a resource, given its ARN.
*/
public suspend inline fun NimbleClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Deletes the tags for a resource.
*/
public suspend inline fun NimbleClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())
/**
* Update a launch profile.
*/
public suspend inline fun NimbleClient.updateLaunchProfile(crossinline block: UpdateLaunchProfileRequest.Builder.() -> Unit): UpdateLaunchProfileResponse = updateLaunchProfile(UpdateLaunchProfileRequest.Builder().apply(block).build())
/**
* Update a user persona in launch profile membership.
*/
public suspend inline fun NimbleClient.updateLaunchProfileMember(crossinline block: UpdateLaunchProfileMemberRequest.Builder.() -> Unit): UpdateLaunchProfileMemberResponse = updateLaunchProfileMember(UpdateLaunchProfileMemberRequest.Builder().apply(block).build())
/**
* Update streaming image.
*/
public suspend inline fun NimbleClient.updateStreamingImage(crossinline block: UpdateStreamingImageRequest.Builder.() -> Unit): UpdateStreamingImageResponse = updateStreamingImage(UpdateStreamingImageRequest.Builder().apply(block).build())
/**
* Update a Studio resource.
*
* Currently, this operation only supports updating the displayName of your studio.
*/
public suspend inline fun NimbleClient.updateStudio(crossinline block: UpdateStudioRequest.Builder.() -> Unit): UpdateStudioResponse = updateStudio(UpdateStudioRequest.Builder().apply(block).build())
/**
* Updates a studio component resource.
*/
public suspend inline fun NimbleClient.updateStudioComponent(crossinline block: UpdateStudioComponentRequest.Builder.() -> Unit): UpdateStudioComponentResponse = updateStudioComponent(UpdateStudioComponentRequest.Builder().apply(block).build())