libZSservicesZSamazonka-ramZSamazonka-ram
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.RAM.AssociateResourceShare

Description

Associates the specified resource share with the specified principals and resources.

Synopsis

Creating a Request

data AssociateResourceShare Source #

See: newAssociateResourceShare smart constructor.

Constructors

AssociateResourceShare' 

Fields

  • clientToken :: Maybe Text

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • principals :: Maybe [Text]

    The principals to associate with the resource share. The possible values are:

    • An Amazon Web Services account ID
    • An Amazon Resource Name (ARN) of an organization in Organizations
    • An ARN of an organizational unit (OU) in Organizations
    • An ARN of an IAM role
    • An ARN of an IAM user

    Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

  • resourceArns :: Maybe [Text]

    The Amazon Resource Names (ARNs) of the resources.

  • resourceShareArn :: Text

    The Amazon Resource Name (ARN) of the resource share.

Instances

Instances details
Eq AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

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

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

Read AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

readsPrec :: Int -> ReadS AssociateResourceShare #

readList :: ReadS [AssociateResourceShare] #

readPrec :: ReadPrec AssociateResourceShare #

readListPrec :: ReadPrec [AssociateResourceShare] #

Show AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

showsPrec :: Int -> AssociateResourceShare -> ShowS #

show :: AssociateResourceShare -> String #

showList :: [AssociateResourceShare] -> ShowS #

Generic AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Associated Types

type Rep AssociateResourceShare :: Type -> Type #

Methods

from :: AssociateResourceShare -> Rep AssociateResourceShare x #

to :: Rep AssociateResourceShare x -> AssociateResourceShare #

NFData AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

rnf :: AssociateResourceShare -> () #

Hashable AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

hashWithSalt :: Int -> AssociateResourceShare -> Int #

hash :: AssociateResourceShare -> Int #

ToJSON AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

toJSON :: AssociateResourceShare -> Value #

toEncoding :: AssociateResourceShare -> Encoding #

toJSONList :: [AssociateResourceShare] -> Value #

toEncodingList :: [AssociateResourceShare] -> Encoding #

AWSRequest AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Associated Types

type AWSResponse AssociateResourceShare #

Methods

request :: AssociateResourceShare -> Request AssociateResourceShare #

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

ToHeaders AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

toHeaders :: AssociateResourceShare -> [Header] #

ToPath AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

toPath :: AssociateResourceShare -> ByteString #

ToQuery AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

toQuery :: AssociateResourceShare -> QueryString #

type Rep AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

type Rep AssociateResourceShare = D1 ('MetaData "AssociateResourceShare" "Amazonka.RAM.AssociateResourceShare" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "AssociateResourceShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resourceShareArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse AssociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

type AWSResponse AssociateResourceShare = AssociateResourceShareResponse

newAssociateResourceShare Source #

Arguments

:: Text

$sel:resourceShareArn:AssociateResourceShare'

-> AssociateResourceShare 

Create a value of AssociateResourceShare 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:AssociateResourceShare', associateResourceShare_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:principals:AssociateResourceShare', associateResourceShare_principals - The principals to associate with the resource share. The possible values are:

  • An Amazon Web Services account ID
  • An Amazon Resource Name (ARN) of an organization in Organizations
  • An ARN of an organizational unit (OU) in Organizations
  • An ARN of an IAM role
  • An ARN of an IAM user

Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

$sel:resourceArns:AssociateResourceShare', associateResourceShare_resourceArns - The Amazon Resource Names (ARNs) of the resources.

$sel:resourceShareArn:AssociateResourceShare', associateResourceShare_resourceShareArn - The Amazon Resource Name (ARN) of the resource share.

Request Lenses

associateResourceShare_clientToken :: Lens' AssociateResourceShare (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

associateResourceShare_principals :: Lens' AssociateResourceShare (Maybe [Text]) Source #

The principals to associate with the resource share. The possible values are:

  • An Amazon Web Services account ID
  • An Amazon Resource Name (ARN) of an organization in Organizations
  • An ARN of an organizational unit (OU) in Organizations
  • An ARN of an IAM role
  • An ARN of an IAM user

Not all resource types can be shared with IAM roles and IAM users. For more information, see Sharing with IAM roles and IAM users in the Resource Access Manager User Guide.

associateResourceShare_resourceArns :: Lens' AssociateResourceShare (Maybe [Text]) Source #

The Amazon Resource Names (ARNs) of the resources.

associateResourceShare_resourceShareArn :: Lens' AssociateResourceShare Text Source #

The Amazon Resource Name (ARN) of the resource share.

Destructuring the Response

data AssociateResourceShareResponse Source #

See: newAssociateResourceShareResponse smart constructor.

Constructors

AssociateResourceShareResponse' 

Fields

Instances

Instances details
Eq AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

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

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

Read AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

readsPrec :: Int -> ReadS AssociateResourceShareResponse #

readList :: ReadS [AssociateResourceShareResponse] #

readPrec :: ReadPrec AssociateResourceShareResponse #

readListPrec :: ReadPrec [AssociateResourceShareResponse] #

Show AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

showsPrec :: Int -> AssociateResourceShareResponse -> ShowS #

show :: AssociateResourceShareResponse -> String #

showList :: [AssociateResourceShareResponse] -> ShowS #

Generic AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Associated Types

type Rep AssociateResourceShareResponse :: Type -> Type #

Methods

from :: AssociateResourceShareResponse -> Rep AssociateResourceShareResponse x #

to :: Rep AssociateResourceShareResponse x -> AssociateResourceShareResponse #

NFData AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

Methods

rnf :: AssociateResourceShareResponse -> () #

type Rep AssociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.AssociateResourceShare

type Rep AssociateResourceShareResponse = D1 ('MetaData "AssociateResourceShareResponse" "Amazonka.RAM.AssociateResourceShare" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "AssociateResourceShareResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceShareAssociations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceShareAssociation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateResourceShareResponse Source #

Arguments

:: Int

$sel:httpStatus:AssociateResourceShareResponse'

-> AssociateResourceShareResponse 

Create a value of AssociateResourceShareResponse 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:AssociateResourceShare', associateResourceShareResponse_clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

$sel:resourceShareAssociations:AssociateResourceShareResponse', associateResourceShareResponse_resourceShareAssociations - Information about the associations.

$sel:httpStatus:AssociateResourceShareResponse', associateResourceShareResponse_httpStatus - The response's http status code.

Response Lenses

associateResourceShareResponse_clientToken :: Lens' AssociateResourceShareResponse (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

associateResourceShareResponse_resourceShareAssociations :: Lens' AssociateResourceShareResponse (Maybe [ResourceShareAssociation]) Source #

Information about the associations.

associateResourceShareResponse_httpStatus :: Lens' AssociateResourceShareResponse Int Source #

The response's http status code.