Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . health ]

describe-affected-entities-for-organization¶

Description¶

Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.

At least one event Amazon Resource Name (ARN) and account ID are required.

Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.

Note

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide .

Synopsis¶

  describe-affected-entities-for-organization
[--organization-entity-filters <value>]
[--locale <value>]
[--organization-entity-account-filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--organization-entity-filters (list)

A JSON set of elements including the awsAccountId and the eventArn .

(structure)

The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.

eventArn -> (string)

The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID `` format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

awsAccountId -> (string)

The 12-digit Amazon Web Services account numbers that contains the affected entities.

Shorthand Syntax:

eventArn=string,awsAccountId=string ...

JSON Syntax:

[
  {
    "eventArn": "string",
    "awsAccountId": "string"
  }
  ...
]

--locale (string)

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

--organization-entity-account-filters (list)

A JSON set of elements including the awsAccountId , eventArn and a set of statusCodes .

(structure)

A JSON set of elements including the awsAccountId , eventArn and a set of statusCodes .

eventArn -> (string)

The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID `` format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

awsAccountId -> (string)

The 12-digit Amazon Web Services account numbers that contains the affected entities.

statusCodes -> (list)

A list of entity status codes.

(string)

Shorthand Syntax:

eventArn=string,awsAccountId=string,statusCodes=string,string ...

JSON Syntax:

[
  {
    "eventArn": "string",
    "awsAccountId": "string",
    "statusCodes": ["IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|"PENDING"|"RESOLVED", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

entities -> (list)

A JSON set of elements including the awsAccountId and its entityArn , entityValue and its entityArn , lastUpdatedTime , and statusCode .

(structure)

Information about an entity that is affected by a Health event.

entityArn -> (string)

The unique identifier for the entity. Format: arn:aws:health:*entity-region* :*aws-account* :entity/*entity-id* `` . Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

eventArn -> (string)

The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID `` format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

entityValue -> (string)

The ID of the affected entity.

entityUrl -> (string)

The URL of the affected entity.

awsAccountId -> (string)

The 12-digit Amazon Web Services account number that contains the affected entity.

lastUpdatedTime -> (timestamp)

The most recent time that the entity was updated.

statusCode -> (string)

The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED , and UNKNOWN .

tags -> (map)

A map of entity tags attached to the affected entity.

Note
Currently, the tags property isn't supported.

key -> (string)

value -> (string)

entityMetadata -> (map)

Additional metadata about the affected entity.

key -> (string)

value -> (string)

failedSet -> (list)

A JSON set of elements of the failed response, including the awsAccountId , errorMessage , errorName , and eventArn .

(structure)

Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.

awsAccountId -> (string)

The 12-digit Amazon Web Services account numbers that contains the affected entities.

eventArn -> (string)

The unique identifier for the event. The event ARN has the ``arn:aws:health:event-region ::event/SERVICE /EVENT_TYPE_CODE /EVENT_TYPE_PLUS_ID `` format.

For example, an event ARN might look like the following:

arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

errorName -> (string)

The name of the error.

errorMessage -> (string)

A message that describes the error. Follow the error message and retry your request.

For example, the InvalidAccountInputError error message appears if you call the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific value for the EventScopeCode parameter, but don't specify an Amazon Web Services account.

nextToken -> (string)

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

Table Of Contents

Feedback

User Guide

Note:

describe-affected-entities-for-organization¶

Description¶

Note

Synopsis¶

Options¶

Global Options¶

Output¶

Note