libZSservicesZSamazonka-nimbleZSamazonka-nimble
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Nimble.UpdateStudio

Description

Update a Studio resource.

Currently, this operation only supports updating the displayName of your studio.

Synopsis

Creating a Request

data UpdateStudio Source #

The studio ID.

See: newUpdateStudio smart constructor.

Constructors

UpdateStudio' 

Fields

  • clientToken :: Maybe Text

    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.

  • userRoleArn :: Maybe Text

    The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

  • displayName :: Maybe Text

    A friendly name for the studio.

  • adminRoleArn :: Maybe Text

    The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

  • studioId :: Text

    The studio ID.

Instances

Instances details
Eq UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

(==) :: UpdateStudio -> UpdateStudio -> Bool #

(/=) :: UpdateStudio -> UpdateStudio -> Bool #

Read UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

readsPrec :: Int -> ReadS UpdateStudio #

readList :: ReadS [UpdateStudio] #

readPrec :: ReadPrec UpdateStudio #

readListPrec :: ReadPrec [UpdateStudio] #

Show UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

showsPrec :: Int -> UpdateStudio -> ShowS #

show :: UpdateStudio -> String #

showList :: [UpdateStudio] -> ShowS #

Generic UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Associated Types

type Rep UpdateStudio :: Type -> Type #

Methods

from :: UpdateStudio -> Rep UpdateStudio x #

to :: Rep UpdateStudio x -> UpdateStudio #

NFData UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

rnf :: UpdateStudio -> () #

Hashable UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

hashWithSalt :: Int -> UpdateStudio -> Int #

hash :: UpdateStudio -> Int #

ToJSON UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

toJSON :: UpdateStudio -> Value #

toEncoding :: UpdateStudio -> Encoding #

toJSONList :: [UpdateStudio] -> Value #

toEncodingList :: [UpdateStudio] -> Encoding #

AWSRequest UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Associated Types

type AWSResponse UpdateStudio #

Methods

request :: UpdateStudio -> Request UpdateStudio #

response :: MonadResource m => Logger -> Service -> Proxy UpdateStudio -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStudio))) #

ToHeaders UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

toHeaders :: UpdateStudio -> [Header] #

ToPath UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

toPath :: UpdateStudio -> ByteString #

ToQuery UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

toQuery :: UpdateStudio -> QueryString #

type Rep UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

type Rep UpdateStudio = D1 ('MetaData "UpdateStudio" "Amazonka.Nimble.UpdateStudio" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" 'False) (C1 ('MetaCons "UpdateStudio'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "userRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "adminRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateStudio Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

type AWSResponse UpdateStudio = UpdateStudioResponse

newUpdateStudio Source #

Arguments

:: Text

$sel:studioId:UpdateStudio'

-> UpdateStudio 

Create a value of UpdateStudio with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:UpdateStudio', updateStudio_clientToken - 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.

$sel:userRoleArn:UpdateStudio', updateStudio_userRoleArn - The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

$sel:displayName:UpdateStudio', updateStudio_displayName - A friendly name for the studio.

$sel:adminRoleArn:UpdateStudio', updateStudio_adminRoleArn - The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

$sel:studioId:UpdateStudio', updateStudio_studioId - The studio ID.

Request Lenses

updateStudio_clientToken :: Lens' UpdateStudio (Maybe Text) Source #

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.

updateStudio_userRoleArn :: Lens' UpdateStudio (Maybe Text) Source #

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

updateStudio_displayName :: Lens' UpdateStudio (Maybe Text) Source #

A friendly name for the studio.

updateStudio_adminRoleArn :: Lens' UpdateStudio (Maybe Text) Source #

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

updateStudio_studioId :: Lens' UpdateStudio Text Source #

The studio ID.

Destructuring the Response

data UpdateStudioResponse Source #

See: newUpdateStudioResponse smart constructor.

Constructors

UpdateStudioResponse' 

Fields

Instances

Instances details
Eq UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

(==) :: UpdateStudioResponse -> UpdateStudioResponse -> Bool #

(/=) :: UpdateStudioResponse -> UpdateStudioResponse -> Bool #

Read UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

readsPrec :: Int -> ReadS UpdateStudioResponse #

readList :: ReadS [UpdateStudioResponse] #

readPrec :: ReadPrec UpdateStudioResponse #

readListPrec :: ReadPrec [UpdateStudioResponse] #

Show UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

showsPrec :: Int -> UpdateStudioResponse -> ShowS #

show :: UpdateStudioResponse -> String #

showList :: [UpdateStudioResponse] -> ShowS #

Generic UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Associated Types

type Rep UpdateStudioResponse :: Type -> Type #

Methods

from :: UpdateStudioResponse -> Rep UpdateStudioResponse x #

to :: Rep UpdateStudioResponse x -> UpdateStudioResponse #

NFData UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

Methods

rnf :: UpdateStudioResponse -> () #

type Rep UpdateStudioResponse Source # 
Instance details

Defined in Amazonka.Nimble.UpdateStudio

type Rep UpdateStudioResponse = D1 ('MetaData "UpdateStudioResponse" "Amazonka.Nimble.UpdateStudio" "libZSservicesZSamazonka-nimbleZSamazonka-nimble" 'False) (C1 ('MetaCons "UpdateStudioResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "studio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Studio)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateStudioResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateStudioResponse'

-> UpdateStudioResponse 

Create a value of UpdateStudioResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:studio:UpdateStudioResponse', updateStudioResponse_studio - Information about a studio.

$sel:httpStatus:UpdateStudioResponse', updateStudioResponse_httpStatus - The response's http status code.

Response Lenses

updateStudioResponse_studio :: Lens' UpdateStudioResponse (Maybe Studio) Source #

Information about a studio.

updateStudioResponse_httpStatus :: Lens' UpdateStudioResponse Int Source #

The response's http status code.