decline-invitations¶

Description¶

Declines invitations to become a member account.

This operation is only used by accounts that are not part of an organization. Organization accounts do not receive invitations.

Synopsis¶

  decline-invitations
--account-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--account-ids (list)

The list of account IDs for the accounts from which to decline the invitations to Security Hub.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To decline an invitation to be a member account

The following decline-invitations example declines an invitation to be a member account of the specified administrator account. The member account is the requesting account.

aws securityhub decline-invitations \
    --account-ids "123456789012"

Output:

{
    "UnprocessedAccounts": []
}

For more information, see Managing administrator and member accounts in the AWS Security Hub User Guide.

Output¶

UnprocessedAccounts -> (list)

The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.

(structure)

Details about the account that was not processed.

AccountId -> (string)

An Amazon Web Services account ID of the account that was not processed.

ProcessingResult -> (string)

The reason that the account was not processed.

Table of Contents

Feedback

User Guide