ListLaunchProfileMembers - Amazon Nimble Studio

ListLaunchProfileMembers

Get all users in a given launch profile membership.

Request Syntax

GET /2020-08-01/studios/studioId/launch-profiles/launchProfileId/membership?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

launchProfileId

The Launch Profile ID.

Required: Yes

maxResults

The max number of results to return in the response.

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

The token to request the next page of results.

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 { "members": [ { "identityStoreId": "string", "persona": "string", "principalId": "string", "sid": "string" } ], "nextToken": "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.

members

A list of members.

Type: Array of LaunchProfileMembership objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

nextToken

The token for the next set of results, or null if there are no more results.

Type: String

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: