@aws-sdk/client-health 3.40.0 → 3.45.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/README.md +19 -20
- package/dist-cjs/endpoints.js +9 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-types/Health.d.ts +77 -82
- package/dist-types/HealthClient.d.ts +19 -20
- package/dist-types/commands/DescribeAffectedAccountsForOrganizationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAffectedEntitiesCommand.d.ts +5 -6
- package/dist-types/commands/DescribeAffectedEntitiesForOrganizationCommand.d.ts +9 -11
- package/dist-types/commands/DescribeEntityAggregatesCommand.d.ts +2 -3
- package/dist-types/commands/DescribeEventAggregatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEventDetailsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeEventDetailsForOrganizationCommand.d.ts +12 -12
- package/dist-types/commands/DescribeEventTypesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeEventsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeEventsForOrganizationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeHealthServiceStatusForOrganizationCommand.d.ts +2 -2
- package/dist-types/commands/DisableHealthServiceAccessForOrganizationCommand.d.ts +11 -11
- package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +72 -65
- package/package.json +6 -6
|
@@ -7,11 +7,11 @@ export interface DescribeAffectedAccountsForOrganizationCommandInput extends Des
|
|
|
7
7
|
export interface DescribeAffectedAccountsForOrganizationCommandOutput extends DescribeAffectedAccountsForOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of accounts in the organization from
|
|
11
|
-
* provided event. For more information about the different types of
|
|
10
|
+
* <p>Returns a list of accounts in the organization from Organizations that are affected by the
|
|
11
|
+
* provided event. For more information about the different types of Health events, see
|
|
12
12
|
* <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>. </p>
|
|
13
|
-
* <p>Before you can call this operation, you must first enable
|
|
14
|
-
*
|
|
13
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
14
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
|
|
15
15
|
* management account.</p>
|
|
16
16
|
* <note>
|
|
17
17
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
@@ -28,7 +28,7 @@ export interface DescribeAffectedAccountsForOrganizationCommandOutput extends De
|
|
|
28
28
|
*
|
|
29
29
|
* @see {@link DescribeAffectedAccountsForOrganizationCommandInput} for command's `input` shape.
|
|
30
30
|
* @see {@link DescribeAffectedAccountsForOrganizationCommandOutput} for command's `response` shape.
|
|
31
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
31
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
32
32
|
*
|
|
33
33
|
*/
|
|
34
34
|
export declare class DescribeAffectedAccountsForOrganizationCommand extends $Command<DescribeAffectedAccountsForOrganizationCommandInput, DescribeAffectedAccountsForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -9,11 +9,10 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of entities that have been affected by the specified events, based on the
|
|
11
11
|
* specified filter criteria. Entities can refer to individual customer resources, groups of
|
|
12
|
-
* customer resources, or any other construct, depending on the
|
|
12
|
+
* customer resources, or any other construct, depending on the Amazon Web Services service. Events that
|
|
13
13
|
* have impact beyond that of the affected entities, or where the extent of impact is unknown,
|
|
14
14
|
* include at least one entity indicating this.</p>
|
|
15
|
-
* <p>At least one event ARN is required
|
|
16
|
-
* <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p>
|
|
15
|
+
* <p>At least one event ARN is required.</p>
|
|
17
16
|
*
|
|
18
17
|
* <note>
|
|
19
18
|
* <ul>
|
|
@@ -21,8 +20,8 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
21
20
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
22
21
|
* </li>
|
|
23
22
|
* <li>
|
|
24
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
25
|
-
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>
|
|
23
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
24
|
+
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
|
|
26
25
|
* </li>
|
|
27
26
|
* </ul>
|
|
28
27
|
* </note>
|
|
@@ -38,7 +37,7 @@ export interface DescribeAffectedEntitiesCommandOutput extends DescribeAffectedE
|
|
|
38
37
|
*
|
|
39
38
|
* @see {@link DescribeAffectedEntitiesCommandInput} for command's `input` shape.
|
|
40
39
|
* @see {@link DescribeAffectedEntitiesCommandOutput} for command's `response` shape.
|
|
41
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
40
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
42
41
|
*
|
|
43
42
|
*/
|
|
44
43
|
export declare class DescribeAffectedEntitiesCommand extends $Command<DescribeAffectedEntitiesCommandInput, DescribeAffectedEntitiesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -8,23 +8,21 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of entities that have been affected by one or more events for one or more
|
|
11
|
-
* accounts in your organization in
|
|
11
|
+
* accounts in your organization in Organizations, based on the filter criteria. Entities can refer
|
|
12
12
|
* to individual customer resources, groups of customer resources, or any other construct,
|
|
13
|
-
* depending on the
|
|
14
|
-
* <p>At least one event Amazon Resource Name (ARN) and account ID are required
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* AWS Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a>
|
|
19
|
-
* operation from your organization's management account.</p>
|
|
13
|
+
* depending on the Amazon Web Services service.</p>
|
|
14
|
+
* <p>At least one event Amazon Resource Name (ARN) and account ID are required.</p>
|
|
15
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
16
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
|
|
17
|
+
* management account.</p>
|
|
20
18
|
* <note>
|
|
21
19
|
* <ul>
|
|
22
20
|
* <li>
|
|
23
21
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
24
22
|
* </li>
|
|
25
23
|
* <li>
|
|
26
|
-
* <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific
|
|
27
|
-
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>
|
|
24
|
+
* <p>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
|
|
25
|
+
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
|
|
28
26
|
* </li>
|
|
29
27
|
* </ul>
|
|
30
28
|
*
|
|
@@ -41,7 +39,7 @@ export interface DescribeAffectedEntitiesForOrganizationCommandOutput extends De
|
|
|
41
39
|
*
|
|
42
40
|
* @see {@link DescribeAffectedEntitiesForOrganizationCommandInput} for command's `input` shape.
|
|
43
41
|
* @see {@link DescribeAffectedEntitiesForOrganizationCommandOutput} for command's `response` shape.
|
|
44
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
42
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
45
43
|
*
|
|
46
44
|
*/
|
|
47
45
|
export declare class DescribeAffectedEntitiesForOrganizationCommand extends $Command<DescribeAffectedEntitiesForOrganizationCommandInput, DescribeAffectedEntitiesForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -7,8 +7,7 @@ export interface DescribeEntityAggregatesCommandInput extends DescribeEntityAggr
|
|
|
7
7
|
export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAggregatesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the number of entities that are affected by each of the specified events
|
|
11
|
-
* events are specified, the counts of all affected entities are returned.</p>
|
|
10
|
+
* <p>Returns the number of entities that are affected by each of the specified events.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -21,7 +20,7 @@ export interface DescribeEntityAggregatesCommandOutput extends DescribeEntityAgg
|
|
|
21
20
|
*
|
|
22
21
|
* @see {@link DescribeEntityAggregatesCommandInput} for command's `input` shape.
|
|
23
22
|
* @see {@link DescribeEntityAggregatesCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
25
24
|
*
|
|
26
25
|
*/
|
|
27
26
|
export declare class DescribeEntityAggregatesCommand extends $Command<DescribeEntityAggregatesCommandInput, DescribeEntityAggregatesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -25,7 +25,7 @@ export interface DescribeEventAggregatesCommandOutput extends DescribeEventAggre
|
|
|
25
25
|
*
|
|
26
26
|
* @see {@link DescribeEventAggregatesCommandInput} for command's `input` shape.
|
|
27
27
|
* @see {@link DescribeEventAggregatesCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
export declare class DescribeEventAggregatesCommand extends $Command<DescribeEventAggregatesCommandInput, DescribeEventAggregatesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -8,14 +8,14 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns detailed information about one or more specified events. Information includes
|
|
11
|
-
* standard event data (
|
|
11
|
+
* standard event data (Amazon Web Services Region, service, and so on, as returned by <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html">DescribeEvents</a>), a detailed event description, and possible additional metadata
|
|
12
12
|
* that depends upon the nature of the event. Affected entities are not included. To retrieve
|
|
13
13
|
* the entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a> operation.</p>
|
|
14
14
|
* <p>If a specified event can't be retrieved, an error message is returned for that
|
|
15
15
|
* event.</p>
|
|
16
16
|
* <note>
|
|
17
|
-
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific
|
|
18
|
-
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>
|
|
17
|
+
* <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more
|
|
18
|
+
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
|
|
19
19
|
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ export interface DescribeEventDetailsCommandOutput extends DescribeEventDetailsR
|
|
|
29
29
|
*
|
|
30
30
|
* @see {@link DescribeEventDetailsCommandInput} for command's `input` shape.
|
|
31
31
|
* @see {@link DescribeEventDetailsCommandOutput} for command's `response` shape.
|
|
32
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
export declare class DescribeEventDetailsCommand extends $Command<DescribeEventDetailsCommandInput, DescribeEventDetailsCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -7,38 +7,38 @@ export interface DescribeEventDetailsForOrganizationCommandInput extends Describ
|
|
|
7
7
|
export interface DescribeEventDetailsForOrganizationCommandOutput extends DescribeEventDetailsForOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns detailed information about one or more specified events for one or more
|
|
11
|
-
* accounts in your organization. This information includes standard event data (such as
|
|
12
|
-
*
|
|
10
|
+
* <p>Returns detailed information about one or more specified events for one or more
|
|
11
|
+
* Amazon Web Services accounts in your organization. This information includes standard event data (such as
|
|
12
|
+
* the Amazon Web Services Region and service), an event description, and (depending on the event) possible
|
|
13
13
|
* metadata. This operation doesn't return affected entities, such as the resources related to
|
|
14
14
|
* the event. To return affected entities, use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html">DescribeAffectedEntitiesForOrganization</a> operation.</p>
|
|
15
15
|
* <note>
|
|
16
|
-
* <p>Before you can call this operation, you must first enable
|
|
17
|
-
*
|
|
16
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
17
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
|
|
18
18
|
* management account.</p>
|
|
19
19
|
* </note>
|
|
20
20
|
* <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, specify
|
|
21
21
|
* the <code>organizationEventDetailFilters</code> object in the request. Depending on the
|
|
22
|
-
*
|
|
22
|
+
* Health event type, note the following differences:</p>
|
|
23
23
|
* <ul>
|
|
24
24
|
* <li>
|
|
25
25
|
* <p>To return event details for a public event, you must specify a null value for the
|
|
26
26
|
* <code>awsAccountId</code> parameter. If you specify an account ID for a public
|
|
27
|
-
* event,
|
|
27
|
+
* event, Health returns an error message because public events aren't specific to
|
|
28
28
|
* an account.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
31
|
* <p>To return event details for an event that is specific to an account in your
|
|
32
|
-
* organization,
|
|
33
|
-
* request. If you don't specify an account ID,
|
|
32
|
+
* organization, you must specify the <code>awsAccountId</code> parameter in the
|
|
33
|
+
* request. If you don't specify an account ID, Health returns an error message
|
|
34
34
|
* because the event is specific to an account in your organization. </p>
|
|
35
35
|
* </li>
|
|
36
36
|
* </ul>
|
|
37
37
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
|
|
38
38
|
*
|
|
39
39
|
* <note>
|
|
40
|
-
* <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific
|
|
41
|
-
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>
|
|
40
|
+
* <p>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
|
|
41
|
+
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions">Resource- and action-based conditions</a> in the <i>Health User Guide</i>.</p>
|
|
42
42
|
* </note>
|
|
43
43
|
* @example
|
|
44
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -52,7 +52,7 @@ export interface DescribeEventDetailsForOrganizationCommandOutput extends Descri
|
|
|
52
52
|
*
|
|
53
53
|
* @see {@link DescribeEventDetailsForOrganizationCommandInput} for command's `input` shape.
|
|
54
54
|
* @see {@link DescribeEventDetailsForOrganizationCommandOutput} for command's `response` shape.
|
|
55
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
55
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
export declare class DescribeEventDetailsForOrganizationCommand extends $Command<DescribeEventDetailsForOrganizationCommandInput, DescribeEventDetailsForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -8,10 +8,10 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns the event types that meet the specified filter criteria. You can use this API
|
|
11
|
-
* operation to find information about the
|
|
11
|
+
* operation to find information about the Health event, such as the category, Amazon Web Services
|
|
12
12
|
* service, and event code. The metadata for each event appears in the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html">EventType</a> object. </p>
|
|
13
13
|
* <p>If you don't specify a filter criteria, the API operation returns all event types, in no
|
|
14
|
-
* particular order.
|
|
14
|
+
* particular order. </p>
|
|
15
15
|
* <note>
|
|
16
16
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
17
17
|
* </note>
|
|
@@ -27,7 +27,7 @@ export interface DescribeEventTypesCommandOutput extends DescribeEventTypesRespo
|
|
|
27
27
|
*
|
|
28
28
|
* @see {@link DescribeEventTypesCommandInput} for command's `input` shape.
|
|
29
29
|
* @see {@link DescribeEventTypesCommandOutput} for command's `response` shape.
|
|
30
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
30
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
31
31
|
*
|
|
32
32
|
*/
|
|
33
33
|
export declare class DescribeEventTypesCommand extends $Command<DescribeEventTypesCommandInput, DescribeEventTypesCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -17,10 +17,10 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
|
|
|
17
17
|
* <ul>
|
|
18
18
|
* <li>
|
|
19
19
|
* <p>When you call the <code>DescribeEvents</code> operation and specify an entity
|
|
20
|
-
* for the <code>entityValues</code> parameter,
|
|
20
|
+
* for the <code>entityValues</code> parameter, Health might return public
|
|
21
21
|
* events that aren't specific to that resource. For example, if you call
|
|
22
22
|
* <code>DescribeEvents</code> and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2)
|
|
23
|
-
* instance,
|
|
23
|
+
* instance, Health might return events that aren't specific to that resource or
|
|
24
24
|
* service. To get events that are specific to a service, use the
|
|
25
25
|
* <code>services</code> parameter in the <code>filter</code> object. For more
|
|
26
26
|
* information, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
|
|
@@ -42,7 +42,7 @@ export interface DescribeEventsCommandOutput extends DescribeEventsResponse, __M
|
|
|
42
42
|
*
|
|
43
43
|
* @see {@link DescribeEventsCommandInput} for command's `input` shape.
|
|
44
44
|
* @see {@link DescribeEventsCommandOutput} for command's `response` shape.
|
|
45
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
45
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
46
46
|
*
|
|
47
47
|
*/
|
|
48
48
|
export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -7,7 +7,7 @@ export interface DescribeEventsForOrganizationCommandInput extends DescribeEvent
|
|
|
7
7
|
export interface DescribeEventsForOrganizationCommandOutput extends DescribeEventsForOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns information about events across your organization in
|
|
10
|
+
* <p>Returns information about events across your organization in Organizations. You can use
|
|
11
11
|
* the<code>filters</code> parameter to specify the events that you want to return. Events
|
|
12
12
|
* are returned in a summary form and don't include the affected accounts, detailed
|
|
13
13
|
* description, any additional metadata that depends on the event type, or any affected
|
|
@@ -32,9 +32,9 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
|
|
|
32
32
|
* <p>If you don't specify a <code>filter</code>, the
|
|
33
33
|
* <code>DescribeEventsForOrganizations</code> returns all events across your organization.
|
|
34
34
|
* Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p>
|
|
35
|
-
* <p>For more information about the different types of
|
|
36
|
-
* <p>Before you can call this operation, you must first enable
|
|
37
|
-
*
|
|
35
|
+
* <p>For more information about the different types of Health events, see <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html">Event</a>.</p>
|
|
36
|
+
* <p>Before you can call this operation, you must first enable Health to work with
|
|
37
|
+
* Organizations. To do this, call the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html">EnableHealthServiceAccessForOrganization</a> operation from your organization's
|
|
38
38
|
* management account.</p>
|
|
39
39
|
* <note>
|
|
40
40
|
* <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p>
|
|
@@ -51,7 +51,7 @@ export interface DescribeEventsForOrganizationCommandOutput extends DescribeEven
|
|
|
51
51
|
*
|
|
52
52
|
* @see {@link DescribeEventsForOrganizationCommandInput} for command's `input` shape.
|
|
53
53
|
* @see {@link DescribeEventsForOrganizationCommandOutput} for command's `response` shape.
|
|
54
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
54
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
55
55
|
*
|
|
56
56
|
*/
|
|
57
57
|
export declare class DescribeEventsForOrganizationCommand extends $Command<DescribeEventsForOrganizationCommandInput, DescribeEventsForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -7,7 +7,7 @@ export interface DescribeHealthServiceStatusForOrganizationCommandInput {
|
|
|
7
7
|
export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends DescribeHealthServiceStatusForOrganizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>This operation provides status information on enabling or disabling
|
|
10
|
+
* <p>This operation provides status information on enabling or disabling Health to work
|
|
11
11
|
* with your organization. To call this operation, you must sign in as an IAM user, assume
|
|
12
12
|
* an IAM role, or sign in as the root user (not recommended) in the organization's
|
|
13
13
|
* management account.</p>
|
|
@@ -23,7 +23,7 @@ export interface DescribeHealthServiceStatusForOrganizationCommandOutput extends
|
|
|
23
23
|
*
|
|
24
24
|
* @see {@link DescribeHealthServiceStatusForOrganizationCommandInput} for command's `input` shape.
|
|
25
25
|
* @see {@link DescribeHealthServiceStatusForOrganizationCommandOutput} for command's `response` shape.
|
|
26
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
26
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
export declare class DescribeHealthServiceStatusForOrganizationCommand extends $Command<DescribeHealthServiceStatusForOrganizationCommandInput, DescribeHealthServiceStatusForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -6,20 +6,20 @@ export interface DisableHealthServiceAccessForOrganizationCommandInput {
|
|
|
6
6
|
export interface DisableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
* <p>Disables
|
|
10
|
-
* in as an
|
|
9
|
+
* <p>Disables Health from working with Organizations. To call this operation, you must sign
|
|
10
|
+
* in as an Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not
|
|
11
11
|
* recommended) in the organization's management account. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
12
|
+
* Health events</a> in the <i>Health User Guide</i>.</p>
|
|
13
|
+
* <p>This operation doesn't remove the service-linked role from the management account in your
|
|
14
|
+
* organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the
|
|
15
|
+
* service-linked role. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role">Deleting a Service-Linked Role</a> in the
|
|
16
16
|
* <i>IAM User Guide</i>.</p>
|
|
17
17
|
* <note>
|
|
18
18
|
* <p>You can also disable the organizational feature by using the Organizations <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html">DisableAWSServiceAccess</a> API operation. After you call this operation,
|
|
19
|
-
*
|
|
20
|
-
* If you call the
|
|
21
|
-
* an error.
|
|
22
|
-
* account.</p>
|
|
19
|
+
* Health stops aggregating events for all other Amazon Web Services accounts in your organization.
|
|
20
|
+
* If you call the Health API operations for organizational view, Health returns
|
|
21
|
+
* an error. Health continues to aggregate health events for your
|
|
22
|
+
* Amazon Web Services account.</p>
|
|
23
23
|
* </note>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,7 +33,7 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
|
|
|
33
33
|
*
|
|
34
34
|
* @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
|
|
35
35
|
* @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
|
|
36
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
36
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
37
37
|
*
|
|
38
38
|
*/
|
|
39
39
|
export declare class DisableHealthServiceAccessForOrganizationCommand extends $Command<DisableHealthServiceAccessForOrganizationCommandInput, DisableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
|
|
@@ -6,29 +6,29 @@ export interface EnableHealthServiceAccessForOrganizationCommandInput {
|
|
|
6
6
|
export interface EnableHealthServiceAccessForOrganizationCommandOutput extends __MetadataBearer {
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
|
-
* <p>Enables
|
|
10
|
-
* to aggregate events from all
|
|
9
|
+
* <p>Enables Health to work with Organizations. You can use the organizational view feature
|
|
10
|
+
* to aggregate events from all Amazon Web Services accounts in your organization in a centralized location. </p>
|
|
11
11
|
* <p>This operation also creates a service-linked role for the management account in the
|
|
12
12
|
* organization. </p>
|
|
13
13
|
* <note>
|
|
14
14
|
* <p>To call this operation, you must meet the following requirements:</p>
|
|
15
15
|
* <ul>
|
|
16
16
|
* <li>
|
|
17
|
-
* <p>You must have a Business or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">
|
|
18
|
-
* API. If you call the
|
|
19
|
-
* Business or Enterprise Support plan, you receive a
|
|
17
|
+
* <p>You must have a Business, Enterprise On-Ramp, or Enterprise Support plan from <a href="http://aws.amazon.com/premiumsupport/">Amazon Web Services Support</a> to use the Health
|
|
18
|
+
* API. If you call the Health API from an Amazon Web Services account that doesn't have a
|
|
19
|
+
* Business, Enterprise On-Ramp, or Enterprise Support plan, you receive a
|
|
20
20
|
* <code>SubscriptionRequiredException</code> error.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
23
|
* <p>You must have permission to call this operation from the organization's
|
|
24
|
-
* management account. For example IAM policies, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html">
|
|
24
|
+
* management account. For example IAM policies, see <a href="https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html">Health
|
|
25
25
|
* identity-based policy examples</a>.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* </ul>
|
|
28
28
|
* </note>
|
|
29
|
-
* <p>If you don't have the required support plan, you can instead use the
|
|
29
|
+
* <p>If you don't have the required support plan, you can instead use the Health console
|
|
30
30
|
* to enable the organizational view feature. For more information, see <a href="https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html">Aggregating
|
|
31
|
-
*
|
|
31
|
+
* Health events</a> in the <i>Health User Guide</i>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -41,7 +41,7 @@ export interface EnableHealthServiceAccessForOrganizationCommandOutput extends _
|
|
|
41
41
|
*
|
|
42
42
|
* @see {@link EnableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
|
|
43
43
|
* @see {@link EnableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
|
|
44
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
44
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
45
45
|
*
|
|
46
46
|
*/
|
|
47
47
|
export declare class EnableHealthServiceAccessForOrganizationCommand extends $Command<EnableHealthServiceAccessForOrganizationCommandInput, EnableHealthServiceAccessForOrganizationCommandOutput, HealthClientResolvedConfig> {
|