openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 224 kB

JSON

{"openapi":"3.0.0","info":{"version":"2020-08-01","x-release":"v4","title":"AmazonNimbleStudio","description":"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.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"nimble","x-aws-signingName":"nimble","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/nimble-2020-08-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/nimble/"},"servers":[{"url":"http://nimble.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonNimbleStudio multi-region endpoint"},{"url":"https://nimble.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AmazonNimbleStudio multi-region endpoint"},{"url":"http://nimble.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonNimbleStudio endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://nimble.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AmazonNimbleStudio endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/2020-08-01/studios/{studioId}/eula-acceptances":{"post":{"operationId":"AcceptEulas","description":"Accept EULAs.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEulasResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"studioId","in":"path","required":true,"description":"The studio ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"eulaIds":{"description":"The EULA ID.","type":"array","items":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListEulaAcceptances","description":"List EULA acceptances.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEulaAcceptancesResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"eulaIds","in":"query","required":false,"description":"The list of EULA IDs that have been previously accepted.","schema":{"type":"array","items":{"$ref":"#/components/schemas/String"}}},{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]}},"/2020-08-01/studios/{studioId}/launch-profiles":{"post":{"operationId":"CreateLaunchProfile","description":"Create a launch profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLaunchProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ec2SubnetIds","launchProfileProtocolVersions","name","streamConfiguration","studioComponentIds"],"properties":{"description":{"description":"A human-readable description of the launch profile.","type":"string","minLength":0,"maxLength":256,"format":"password"},"ec2SubnetIds":{"description":"Specifies the IDs of the EC2 subnets where streaming sessions will be accessible from. These subnets must support the specified instance types. ","type":"array","items":{"$ref":"#/components/schemas/EC2SubnetId"},"minItems":0,"maxItems":6},"launchProfileProtocolVersions":{"description":"The version number of the protocol that is used by the launch profile. The only valid version is \"2021-03-31\".","type":"array","items":{"$ref":"#/components/schemas/LaunchProfileProtocolVersion"}},"name":{"description":"The name for the launch profile.","type":"string","minLength":1,"maxLength":64,"format":"password"},"streamConfiguration":{"description":"Configuration for streaming workstations created using this launch profile.","type":"object","properties":{"automaticTerminationMode":{"allOf":[{"$ref":"#/components/schemas/AutomaticTerminationMode"},{"description":"Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a <code>STOPPED</code> state. <ul> <li> When <code>ACTIVATED</code>, the streaming session is scheduled for termination after being in the <code>STOPPED</code> state for the time specified in <code>maxStoppedSessionLengthInMinutes</code>. </li> <li> When <code>DEACTIVATED</code>, the streaming session can remain in the <code>STOPPED</code> state indefinitely. </li> </ul> This parameter is only allowed when <code>sessionPersistenceMode</code> is <code>ACTIVATED</code>. When allowed, the default value for this parameter is <code>DEACTIVATED</code>."}]},"clipboardMode":{"allOf":[{"$ref":"#/components/schemas/StreamingClipboardMode"},{"description":"Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client."}]},"ec2InstanceTypes":{"allOf":[{"$ref":"#/components/schemas/StreamingInstanceTypeList"},{"description":"The EC2 instance types that users can select from when launching a streaming session with this launch profile."}]},"maxSessionLengthInMinutes":{"allOf":[{"$ref":"#/components/schemas/StreamConfigurationMaxSessionLengthInMinutes"},{"description":"The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days."}]},"maxStoppedSessionLengthInMinutes":{"allOf":[{"$ref":"#/components/schemas/StreamConfigurationMaxStoppedSessionLengthInMinutes"},{"description":"Integer that determines if you can start and stop your sessions and how long a session can stay in the <code>STOPPED</code> state. The default value is 0. The maximum value is 5760. This field is allowed only when <code>sessionPersistenceMode</code> is <code>ACTIVATED</code> and <code>automaticTerminationMode</code> is <code>ACTIVATED</code>. If the value is set to 0, your sessions can’t be <code>STOPPED</code>. If you then call <code>StopStreamingSession</code>, the session fails. If the time that a session stays in the <code>READY</code> state exceeds the <code>maxSessionLengthInMinutes</code> value, the session will automatically be terminated (instead of <code>STOPPED</code>). If the value is set to a positive number, the session can be stopped. You can call <code>StopStreamingSession</code> to stop sessions in the <code>READY</code> state. If the time that a session stays in the <code>READY</code> state exceeds the <code>maxSessionLengthInMinutes</code> value, the session will automatically be stopped (instead of terminated)."}]},"sessionBackup":{"allOf":[{"$ref":"#/components/schemas/StreamConfigurationSessionBackup"},{"description":"Configures how streaming sessions are backed up when launched from this launch profile."}]},"sessionPersistenceMode":{"allOf":[{"$ref":"#/components/schemas/SessionPersistenceMode"},{"description":"Determine if a streaming session created from this launch profile can configure persistent storage. This means that <code>volumeConfiguration</code> and <code>automaticTerminationMode</code> are configured."}]},"sessionStorage":{"allOf":[{"$ref":"#/components/schemas/StreamConfigurationSessionStorage"},{"description":"The upload storage for a streaming workstation that is created using this launch profile."}]},"streamingImageIds":{"allOf":[{"$ref":"#/components/schemas/StreamingImageIdList"},{"description":"The streaming images that users can select from when launching a streaming session with this launch profile."}]},"volumeConfiguration":{"allOf":[{"$ref":"#/components/schemas/VolumeConfiguration"},{"description":"Custom volume configuration for the root volumes that are attached to streaming sessions. This parameter is only allowed when <code>sessionPersistenceMode</code> is <code>ACTIVATED</code>."}]}}},"studioComponentIds":{"description":"Unique identifiers for a collection of studio components that can be used with this launch profile.","type":"array","items":{"$ref":"#/components/schemas/String"},"minItems":1,"maxItems":100},"tags":{"description":"A collection of labels, in the form of key-value pairs, that apply to this resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListLaunchProfiles","description":"List all the launch profiles a studio.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLaunchProfilesResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The max number of results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}},{"name":"principalId","in":"query","required":false,"description":"The principal ID. This currently supports a IAM Identity Center UserId. ","schema":{"type":"string"}},{"name":"states","in":"query","required":false,"description":"Filter this request to launch profiles in any of the given states.","schema":{"type":"array","items":{"$ref":"#/components/schemas/LaunchProfileState"}}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]}},"/2020-08-01/studios/{studioId}/streaming-images":{"post":{"operationId":"CreateStreamingImage","description":"Creates a streaming image resource in a studio.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStreamingImageResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ec2ImageId","name"],"properties":{"description":{"description":"The description.","type":"string","minLength":0,"maxLength":256,"format":"password"},"ec2ImageId":{"description":"The ID of an EC2 machine image with which to create this streaming image.","type":"string","pattern":"^ami-[0-9A-z]+$"},"name":{"description":"A friendly name for a streaming image resource.","type":"string","minLength":0,"maxLength":64,"format":"password"},"tags":{"description":"A collection of labels, in the form of key-value pairs, that apply to this resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListStreamingImages","description":"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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStreamingImagesResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}},{"name":"owner","in":"query","required":false,"description":"Filter this request to streaming images with the given owner","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]}},"/2020-08-01/studios/{studioId}/streaming-sessions":{"post":{"operationId":"CreateStreamingSession","description":"Creates a streaming session in a studio. After invoking this operation, you must poll GetStreamingSession until the streaming session is in the <code>READY</code> state.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStreamingSessionResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["launchProfileId"],"properties":{"ec2InstanceType":{"description":"The EC2 Instance type used for the streaming session.","type":"string","enum":["g4dn.xlarge","g4dn.2xlarge","g4dn.4xlarge","g4dn.8xlarge","g4dn.12xlarge","g4dn.16xlarge","g3.4xlarge","g3s.xlarge","g5.xlarge","g5.2xlarge","g5.4xlarge","g5.8xlarge","g5.16xlarge"]},"launchProfileId":{"description":"The ID of the launch profile used to control access from the streaming session.","type":"string"},"ownedBy":{"description":"The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.","type":"string"},"streamingImageId":{"description":"The ID of the streaming image.","type":"string","pattern":"^[a-zA-Z0-9-_]*$","minLength":0,"maxLength":22},"tags":{"description":"A collection of labels, in the form of key-value pairs, that apply to this resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListStreamingSessions","description":"Lists the streaming sessions in a studio.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStreamingSessionsResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"createdBy","in":"query","required":false,"description":"Filters the request to streaming sessions created by the given user.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}},{"name":"ownedBy","in":"query","required":false,"description":"Filters the request to streaming session owned by the given user","schema":{"type":"string"}},{"name":"sessionIds","in":"query","required":false,"description":"Filters the request to only the provided session IDs.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]}},"/2020-08-01/studios/{studioId}/streaming-sessions/{sessionId}/streams":{"post":{"operationId":"CreateStreamingSessionStream","description":"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 <code>READY</code> state.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStreamingSessionStreamResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"sessionId","in":"path","required":true,"description":"The streaming session ID.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expirationInSeconds":{"description":"The expiration time in seconds.","type":"integer","minimum":60,"maximum":3600}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/2020-08-01/studios":{"post":{"operationId":"CreateStudio","description":"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 <code>AmazonNimbleStudio-StudioUser</code> managed policy attached for the portal to function properly. The admin role must have the <code>AmazonNimbleStudio-StudioAdmin</code> managed policy attached for the portal to function properly. You may optionally specify a KMS key in the <code>StudioEncryptionConfiguration</code>. 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 <code>CreateStudio</code> 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.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStudioResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["adminRoleArn","displayName","studioName","userRoleArn"],"properties":{"adminRoleArn":{"description":"The IAM role that studio admins will assume when logging in to the Nimble Studio portal.","type":"string","minLength":0,"maxLength":2048},"displayName":{"description":"A friendly name for the studio.","type":"string","minLength":0,"maxLength":64,"format":"password"},"studioEncryptionConfiguration":{"description":"Configuration of the encryption method that is used for the studio.","type":"object","properties":{"keyArn":{"allOf":[{"$ref":"#/components/schemas/StudioEncryptionConfigurationKeyArn"},{"description":"The ARN for a KMS key that is used to encrypt studio data."}]},"keyType":{"allOf":[{"$ref":"#/components/schemas/StudioEncryptionConfigurationKeyType"},{"description":"The type of KMS key that is used to encrypt studio data."}]}}},"studioName":{"description":"The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.","type":"string","pattern":"^[a-z0-9]*$","minLength":3,"maxLength":64},"tags":{"description":"A collection of labels, in the form of key-value pairs, that apply to this resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"userRoleArn":{"description":"The IAM role that studio users will assume when logging in to the Nimble Studio portal.","type":"string","minLength":0,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListStudios","description":"List studios in your Amazon Web Services accounts in the requested Amazon Web Services Region.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStudiosResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}}]}},"/2020-08-01/studios/{studioId}/studio-components":{"post":{"operationId":"CreateStudioComponent","description":"Creates a studio component resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStudioComponentResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","type"],"properties":{"configuration":{"description":"The configuration of the studio component, based on component type.","type":"object","properties":{"activeDirectoryConfiguration":{"allOf":[{"$ref":"#/components/schemas/ActiveDirectoryConfiguration"},{"description":"The configuration for a Directory Service for Microsoft Active Directory studio resource."}]},"computeFarmConfiguration":{"allOf":[{"$ref":"#/components/schemas/ComputeFarmConfiguration"},{"description":"The configuration for a render farm that is associated with a studio resource."}]},"licenseServiceConfiguration":{"allOf":[{"$ref":"#/components/schemas/LicenseServiceConfiguration"},{"description":"The configuration for a license service that is associated with a studio resource."}]},"sharedFileSystemConfiguration":{"allOf":[{"$ref":"#/components/schemas/SharedFileSystemConfiguration"},{"description":"The configuration for a shared file storage system that is associated with a studio resource."}]}}},"description":{"description":"The description.","type":"string","minLength":0,"maxLength":256,"format":"password"},"ec2SecurityGroupIds":{"description":"The EC2 security groups that control access to the studio component.","type":"array","items":{"$ref":"#/components/schemas/SecurityGroupId"},"minItems":0,"maxItems":30},"initializationScripts":{"description":"Initialization scripts for studio components.","type":"array","items":{"$ref":"#/components/schemas/StudioComponentInitializationScript"}},"name":{"description":"The name for the studio component.","type":"string","minLength":0,"maxLength":64,"format":"password"},"runtimeRoleArn":{"description":"An IAM role attached to a Studio Component that gives the studio component access to Amazon Web Services resources at anytime while the instance is running. ","type":"string","minLength":0,"maxLength":2048},"scriptParameters":{"description":"Parameters for the studio component scripts.","type":"array","items":{"$ref":"#/components/schemas/ScriptParameterKeyValue"},"minItems":0,"maxItems":30},"secureInitializationRoleArn":{"description":"An IAM role attached to Studio Component when the system initialization script runs which give the studio component access to Amazon Web Services resources when the system initialization script runs.","type":"string","minLength":0,"maxLength":2048},"subtype":{"description":"The specific subtype of a studio component.","type":"string","enum":["AWS_MANAGED_MICROSOFT_AD","AMAZON_FSX_FOR_WINDOWS","AMAZON_FSX_FOR_LUSTRE","CUSTOM"]},"tags":{"description":"A collection of labels, in the form of key-value pairs, that apply to this resource.","type":"object","additionalProperties":{"$ref":"#/components/schemas/String"}},"type":{"description":"The type of the studio component.","type":"string","enum":["ACTIVE_DIRECTORY","SHARED_FILE_SYSTEM","COMPUTE_FARM","LICENSE_SERVICE","CUSTOM"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListStudioComponents","description":"Lists the <code>StudioComponents</code> in a studio.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListStudioComponentsResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"maxResults","in":"query","required":false,"description":"The max number of results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"nextToken","in":"query","required":false,"description":"The token for the next set of results, or null if there are no more results.","schema":{"type":"string"}},{"name":"states","in":"query","required":false,"description":"Filters the request to studio components that are in one of the given states. ","schema":{"type":"array","items":{"$ref":"#/components/schemas/StudioComponentState"}}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}},{"name":"types","in":"query","required":false,"description":"Filters the request to studio components that are of one of the given types.","schema":{"type":"array","items":{"$ref":"#/components/schemas/StudioComponentType"}}}]}},"/2020-08-01/studios/{studioId}/launch-profiles/{launchProfileId}":{"delete":{"operationId":"DeleteLaunchProfile","description":"Permanently delete a launch profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLaunchProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"launchProfileId","in":"path","required":true,"description":"The ID of the launch profile used to control access from the streaming session.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetLaunchProfile","description":"Get a launch profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLaunchProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"launchProfileId","in":"path","required":true,"description":"The ID of the launch profile used to control access from the streaming session.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateLaunchProfile","description":"Update a launch profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLaunchProfileResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"InternalServerErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorException"}}}},"486":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}}},"parameters":[{"name":"X-Amz-Client-Token","in":"header","required":false,"description":"Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency.","schema":{"type":"string","minLength":1,"maxLength":64}},{"name":"launchProfileId","in":"path","required":true,"description":"The ID of the launch profile used to control access from the streaming session.","schema":{"type":"string"}},{"name":"studioId","in":"path","required":true,"description":"The studio ID. ","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"description":"A human-read