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.DisassociateResourceShare

Description

Disassociates the specified principals or resources from the specified resource share.

Synopsis

Creating a Request

data DisassociateResourceShare Source #

See: newDisassociateResourceShare smart constructor.

Constructors

DisassociateResourceShare' 

Fields

  • 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.

  • principals :: Maybe [Text]

    Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

    You can include the following values:

    • An Amazon Web Services account ID, for example: 123456789012
    • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
    • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
    • An ARN of an IAM role, for example: iam::123456789012:role/rolename
    • An ARN of an IAM user, for example: iam::123456789012user/username

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

  • resourceArns :: Maybe [Text]

    Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals outside of the Amazon Web Services account that created the resources.

  • resourceShareArn :: Text

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

Instances

Instances details
ToJSON DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

ToHeaders DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

ToPath DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

ToQuery DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

AWSRequest DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Generic DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Associated Types

type Rep DisassociateResourceShare :: Type -> Type #

Read DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Show DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

NFData DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Eq DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Hashable DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

type AWSResponse DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

type Rep DisassociateResourceShare Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

type Rep DisassociateResourceShare = D1 ('MetaData "DisassociateResourceShare" "Amazonka.RAM.DisassociateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "DisassociateResourceShare'" '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))))

newDisassociateResourceShare Source #

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

DisassociateResourceShare, disassociateResourceShare_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.

$sel:principals:DisassociateResourceShare', disassociateResourceShare_principals - Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012
  • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
  • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • An ARN of an IAM role, for example: iam::123456789012:role/rolename
  • An ARN of an IAM user, for example: iam::123456789012user/username

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

$sel:resourceArns:DisassociateResourceShare', disassociateResourceShare_resourceArns - Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals outside of the Amazon Web Services account that created the resources.

DisassociateResourceShare, disassociateResourceShare_resourceShareArn - Specifies Amazon Resoure Name (ARN) of the resource share that you want to remove resources from.

Request Lenses

disassociateResourceShare_clientToken :: Lens' DisassociateResourceShare (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.

disassociateResourceShare_principals :: Lens' DisassociateResourceShare (Maybe [Text]) Source #

Specifies a list of one or more principals that no longer are to have access to the resources in this resource share.

You can include the following values:

  • An Amazon Web Services account ID, for example: 123456789012
  • An Amazon Resoure Name (ARN) of an organization in Organizations, for example: organizations::123456789012:organization/o-exampleorgid
  • An ARN of an organizational unit (OU) in Organizations, for example: organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
  • An ARN of an IAM role, for example: iam::123456789012:role/rolename
  • An ARN of an IAM user, for example: iam::123456789012user/username

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

disassociateResourceShare_resourceArns :: Lens' DisassociateResourceShare (Maybe [Text]) Source #

Specifies a list of Amazon Resource Names (ARNs) for one or more resources that you want to remove from the resource share. After the operation runs, these resources are no longer shared with principals outside of the Amazon Web Services account that created the resources.

disassociateResourceShare_resourceShareArn :: Lens' DisassociateResourceShare Text Source #

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

Destructuring the Response

data DisassociateResourceShareResponse Source #

See: newDisassociateResourceShareResponse smart constructor.

Constructors

DisassociateResourceShareResponse' 

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.

  • resourceShareAssociations :: Maybe [ResourceShareAssociation]

    An array of objects that contain information about the updated associations for this resource share.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Associated Types

type Rep DisassociateResourceShareResponse :: Type -> Type #

Read DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Show DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

NFData DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

Eq DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

type Rep DisassociateResourceShareResponse Source # 
Instance details

Defined in Amazonka.RAM.DisassociateResourceShare

type Rep DisassociateResourceShareResponse = D1 ('MetaData "DisassociateResourceShareResponse" "Amazonka.RAM.DisassociateResourceShare" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "DisassociateResourceShareResponse'" '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))))

newDisassociateResourceShareResponse Source #

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

DisassociateResourceShare, disassociateResourceShareResponse_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.

DisassociateResourceShareResponse, disassociateResourceShareResponse_resourceShareAssociations - An array of objects that contain information about the updated associations for this resource share.

$sel:httpStatus:DisassociateResourceShareResponse', disassociateResourceShareResponse_httpStatus - The response's http status code.

Response Lenses

disassociateResourceShareResponse_clientToken :: Lens' DisassociateResourceShareResponse (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.

disassociateResourceShareResponse_resourceShareAssociations :: Lens' DisassociateResourceShareResponse (Maybe [ResourceShareAssociation]) Source #

An array of objects that contain information about the updated associations for this resource share.