StudioMembership - Amazon Nimble Studio

StudioMembership

Represents a studio membership collection resource.

Studio membership is a collection of studio members. It describes the studio users who have been given elevated access to the studio. Studio membership enables you to specify which users have admin permissions in the Nimble Studio portal.

When you add a user to your studio using the Nimble Studio console, they can access the studio's AWS SSO application and are allowed to log in to the Nimble Studio portal. These users have IAM role permissions and do not appear in the studio membership collection. Only studio admins appear in studio membership.

URI

/2020-08-01/studios/studioId/membership

HTTP methods

GET

Operation ID: ListStudioMembers

Get all users in a given studio membership.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Query parameters
Name Type Required Description
nextToken String False

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

maxResults String False

The maximum number of results to be returned per request.

Responses
Status code Response model Description
200 ListStudioMembersOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

POST

Operation ID: PutStudioMembers

Add/update users with given persona to studio membership.

Path parameters
Name Type Required Description
studioId String True

The studio ID.

Header parameters
Name Type Required Description
X-Amz-Client-Token String False

To make an idempotent API request using one of these actions, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails with a ValidationException error.

Responses
Status code Response model Description
200 PutStudioMembersOutput

Success

400 ValidationException

One of the parameters in the request is invalid.

402 ServiceQuotaExceededException

This request would cause a service quota to be exceeded. Please use the AWS Service Quotas console to request an increase.

403 AccessDeniedException

You do not have permission to perform this action.

404 ResourceNotFoundException

A requested resource was not found.

409 ConflictException

This request conflicts with another concurrent request. Please retry your request.

429 ThrottlingException

The request was denied due to request throttling. Please retry your request.

500 InternalServerException

A service fault has occurred. Please retry your request and contact AWS Support if this error continues.

Schemas

Request bodies

{ "identityStoreId": "string", "members": [ { "persona": enum, "principalId": "string" } ] }
{ "identityStoreId": "string", "members": [ { "persona": enum, "principalId": "string" } ] }

Response bodies

{ "members": [ { "persona": enum, "principalId": "string", "identityStoreId": "string" } ], "nextToken": "string" }
{ }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }
{ "message": "string", "code": "string", "context": { } }

Properties

AccessDeniedException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ConflictException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ExceptionContext

ExceptionContext is a set of key-value pairs that provide you with more information about the error that occurred. For example, when the service returns a 404 ResourceNotFound error, ExceptionContext will contain the key `resourceId` with the value of resource that was not found.

ExceptionContext enables scripts and other programmatic clients to provide for better error handling.

Property Type Required Description

*

string

False

InternalServerException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ListStudioMembersOutput

Property Type Required Description
members

Array of type StudioMembership

False

A list of members.

nextToken

string

False

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

NewStudioMember

Property Type Required Description
persona

StudioPersona

True

The persona.

principalId

string

True

The principal ID.

PutStudioMembersInput

Property Type Required Description
identityStoreId

string

True

The ID of the identity store.

members

Array of type NewStudioMember

True

A list of members.

PutStudioMembersOutput

ResourceNotFoundException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ServiceQuotaExceededException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

StudioMembership

Property Type Required Description
persona

StudioPersona

False

The persona.

principalId

string

False

The principal ID.

identityStoreId

string

False

The ID of the identity store.

StudioPersona

  • ADMINISTRATOR

ThrottlingException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

ValidationException

Property Type Required Description
message

string

False

A human-readable description of the error.

code

string

False

A more specific error code.

context

ExceptionContext

False

The exception context.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListStudioMembers

PutStudioMembers