libZSservicesZSamazonka-detectiveZSamazonka-detective
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.Detective.DeleteMembers

Description

Deletes one or more member accounts from the administrator account's behavior graph. This operation can only be called by a Detective administrator account. That account cannot use DeleteMembers to delete their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.

Synopsis

Creating a Request

data DeleteMembers Source #

See: newDeleteMembers smart constructor.

Constructors

DeleteMembers' 

Fields

  • graphArn :: Text

    The ARN of the behavior graph to delete members from.

  • accountIds :: NonEmpty Text

    The list of AWS account identifiers for the member accounts to delete from the behavior graph. You can delete up to 50 member accounts at a time.

Instances

Instances details
Eq DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Read DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Show DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Generic DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Associated Types

type Rep DeleteMembers :: Type -> Type #

NFData DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Methods

rnf :: DeleteMembers -> () #

Hashable DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

ToJSON DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

AWSRequest DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Associated Types

type AWSResponse DeleteMembers #

ToHeaders DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

ToPath DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

ToQuery DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

type Rep DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

type Rep DeleteMembers = D1 ('MetaData "DeleteMembers" "Amazonka.Detective.DeleteMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "DeleteMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "graphArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))
type AWSResponse DeleteMembers Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

newDeleteMembers Source #

Create a value of DeleteMembers 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:graphArn:DeleteMembers', deleteMembers_graphArn - The ARN of the behavior graph to delete members from.

$sel:accountIds:DeleteMembers', deleteMembers_accountIds - The list of AWS account identifiers for the member accounts to delete from the behavior graph. You can delete up to 50 member accounts at a time.

Request Lenses

deleteMembers_graphArn :: Lens' DeleteMembers Text Source #

The ARN of the behavior graph to delete members from.

deleteMembers_accountIds :: Lens' DeleteMembers (NonEmpty Text) Source #

The list of AWS account identifiers for the member accounts to delete from the behavior graph. You can delete up to 50 member accounts at a time.

Destructuring the Response

data DeleteMembersResponse Source #

See: newDeleteMembersResponse smart constructor.

Constructors

DeleteMembersResponse' 

Fields

  • accountIds :: Maybe (NonEmpty Text)

    The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior graph.

  • unprocessedAccounts :: Maybe [UnprocessedAccount]

    The list of member accounts that Detective was not able to delete from the behavior graph. For each member account, provides the reason that the deletion could not be processed.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Read DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Show DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Generic DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Associated Types

type Rep DeleteMembersResponse :: Type -> Type #

NFData DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

Methods

rnf :: DeleteMembersResponse -> () #

type Rep DeleteMembersResponse Source # 
Instance details

Defined in Amazonka.Detective.DeleteMembers

type Rep DeleteMembersResponse = D1 ('MetaData "DeleteMembersResponse" "Amazonka.Detective.DeleteMembers" "libZSservicesZSamazonka-detectiveZSamazonka-detective" 'False) (C1 ('MetaCons "DeleteMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "unprocessedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UnprocessedAccount])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteMembersResponse Source #

Create a value of DeleteMembersResponse 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:accountIds:DeleteMembers', deleteMembersResponse_accountIds - The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior graph.

$sel:unprocessedAccounts:DeleteMembersResponse', deleteMembersResponse_unprocessedAccounts - The list of member accounts that Detective was not able to delete from the behavior graph. For each member account, provides the reason that the deletion could not be processed.

$sel:httpStatus:DeleteMembersResponse', deleteMembersResponse_httpStatus - The response's http status code.

Response Lenses

deleteMembersResponse_accountIds :: Lens' DeleteMembersResponse (Maybe (NonEmpty Text)) Source #

The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior graph.

deleteMembersResponse_unprocessedAccounts :: Lens' DeleteMembersResponse (Maybe [UnprocessedAccount]) Source #

The list of member accounts that Detective was not able to delete from the behavior graph. For each member account, provides the reason that the deletion could not be processed.