amazonka-ram-2.0: Amazon Resource Access Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RAM.UpdateResourceShare

Description

Modifies some of the properties of the specified resource share.

Synopsis

Creating a Request

data UpdateResourceShare Source #

See: newUpdateResourceShare smart constructor.

Constructors

UpdateResourceShare' 

Fields

  • allowExternalPrincipals :: Maybe Bool

    Specifies whether principals outside your organization in Organizations can be associated with a resource share.

  • clientToken :: Maybe Text

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

  • name :: Maybe Text

    If specified, the new name that you want to attach to the resource share.

  • resourceShareArn :: Text

    Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

Instances

Instances details
ToJSON UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

toJSON :: UpdateResourceShare -> Value #

toEncoding :: UpdateResourceShare -> Encoding #

toJSONList :: [UpdateResourceShare] -> Value #

toEncodingList :: [UpdateResourceShare] -> Encoding #

ToHeaders UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

toHeaders :: UpdateResourceShare -> [Header] #

ToPath UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

toPath :: UpdateResourceShare -> ByteString #

ToQuery UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

toQuery :: UpdateResourceShare -> QueryString #

AWSRequest UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Associated Types

type AWSResponse UpdateResourceShare #

Methods

request :: (Service -> Service) -> UpdateResourceShare -> Request UpdateResourceShare #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateResourceShare -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateResourceShare))) #

Generic UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Associated Types

type Rep UpdateResourceShare :: Type -> Type #

Methods

from :: UpdateResourceShare -> Rep UpdateResourceShare x #

to :: Rep UpdateResourceShare x -> UpdateResourceShare #

Read UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

readsPrec :: Int -> ReadS UpdateResourceShare #

readList :: ReadS [UpdateResourceShare] #

readPrec :: ReadPrec UpdateResourceShare #

readListPrec :: ReadPrec [UpdateResourceShare] #

Show UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

showsPrec :: Int -> UpdateResourceShare -> ShowS #

show :: UpdateResourceShare -> String #

showList :: [UpdateResourceShare] -> ShowS #

NFData UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

rnf :: UpdateResourceShare -> () #

Eq UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

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

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

Hashable UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

hashWithSalt :: Int -> UpdateResourceShare -> Int #

hash :: UpdateResourceShare -> Int #

type AWSResponse UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

type AWSResponse UpdateResourceShare = UpdateResourceShareResponse
type Rep UpdateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

type Rep UpdateResourceShare = D1 ('MetaData "UpdateResourceShare" "Amazonka.RAM.UpdateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "UpdateResourceShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowExternalPrincipals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceShareArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateResourceShare Source #

Arguments

:: Text

UpdateResourceShare

-> UpdateResourceShare 

Create a value of UpdateResourceShare 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:

UpdateResourceShare, updateResourceShare_allowExternalPrincipals - Specifies whether principals outside your organization in Organizations can be associated with a resource share.

UpdateResourceShare, updateResourceShare_clientToken - Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

UpdateResourceShare, updateResourceShare_name - If specified, the new name that you want to attach to the resource share.

UpdateResourceShare, updateResourceShare_resourceShareArn - Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

Request Lenses

updateResourceShare_allowExternalPrincipals :: Lens' UpdateResourceShare (Maybe Bool) Source #

Specifies whether principals outside your organization in Organizations can be associated with a resource share.

updateResourceShare_clientToken :: Lens' UpdateResourceShare (Maybe Text) Source #

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

updateResourceShare_name :: Lens' UpdateResourceShare (Maybe Text) Source #

If specified, the new name that you want to attach to the resource share.

updateResourceShare_resourceShareArn :: Lens' UpdateResourceShare Text Source #

Specifies the Amazon Resoure Name (ARN) of the resource share that you want to modify.

Destructuring the Response

data UpdateResourceShareResponse Source #

See: newUpdateResourceShareResponse smart constructor.

Constructors

UpdateResourceShareResponse' 

Fields

  • clientToken :: Maybe Text

    The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

  • resourceShare :: Maybe ResourceShare

    Information about the resource share.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Associated Types

type Rep UpdateResourceShareResponse :: Type -> Type #

Methods

from :: UpdateResourceShareResponse -> Rep UpdateResourceShareResponse x #

to :: Rep UpdateResourceShareResponse x -> UpdateResourceShareResponse #

Read UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

readsPrec :: Int -> ReadS UpdateResourceShareResponse #

readList :: ReadS [UpdateResourceShareResponse] #

readPrec :: ReadPrec UpdateResourceShareResponse #

readListPrec :: ReadPrec [UpdateResourceShareResponse] #

Show UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

showsPrec :: Int -> UpdateResourceShareResponse -> ShowS #

show :: UpdateResourceShareResponse -> String #

showList :: [UpdateResourceShareResponse] -> ShowS #

NFData UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

rnf :: UpdateResourceShareResponse -> () #

Eq UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

Methods

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

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

type Rep UpdateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.UpdateResourceShare

type Rep UpdateResourceShareResponse = D1 ('MetaData "UpdateResourceShareResponse" "Amazonka.RAM.UpdateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "UpdateResourceShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceShare") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceShare)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateResourceShareResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateResourceShareResponse'

-> UpdateResourceShareResponse 

Create a value of UpdateResourceShareResponse 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:

UpdateResourceShare, updateResourceShareResponse_clientToken - The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

$sel:resourceShare:UpdateResourceShareResponse', updateResourceShareResponse_resourceShare - Information about the resource share.

$sel:httpStatus:UpdateResourceShareResponse', updateResourceShareResponse_httpStatus - The response's http status code.

Response Lenses

updateResourceShareResponse_clientToken :: Lens' UpdateResourceShareResponse (Maybe Text) Source #

The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

updateResourceShareResponse_resourceShare :: Lens' UpdateResourceShareResponse (Maybe ResourceShare) Source #

Information about the resource share.

updateResourceShareResponse_httpStatus :: Lens' UpdateResourceShareResponse Int Source #

The response's http status code.