GetLaunchProfileMember
Get a user persona in launch profile membership.
Important
This API is only available to customers who created a Nimble Studio cloud studio before June 19th, 2023. This API won't be accessible after June 19th, 2024.
Request Syntax
GET /2020-08-01/studios/studioId
/launch-profiles/launchProfileId
/membership/principalId
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- launchProfileId
-
The ID of the launch profile used to control access from the streaming session.
Required: Yes
- principalId
-
The principal ID. This currently supports a IAM Identity Center UserId.
Required: Yes
- studioId
-
The studio ID.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"member": {
"identityStoreId": "string",
"persona": "string",
"principalId": "string",
"sid": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- member
-
The member.
Type: LaunchProfileMembership object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.
HTTP Status Code: 403
- ConflictException
-
Another operation is in progress.
HTTP Status Code: 409
- InternalServerErrorException
-
An internal error has occurred. Please retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.
Please use AWS Service Quotas to request an increase.
HTTP Status Code: 402
- ThrottlingException
-
The request throughput limit was exceeded.
HTTP Status Code: 429
- ValidationException
-
One of the parameters in the request is invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: