@aws-sdk/client-health 3.39.0 → 3.43.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 -19
- package/dist-cjs/endpoints.js +75 -15
- package/dist-cjs/runtimeConfig.browser.js +6 -3
- package/dist-cjs/runtimeConfig.js +5 -3
- package/dist-es/endpoints.js +75 -15
- package/dist-es/runtimeConfig.browser.js +3 -2
- package/dist-es/runtimeConfig.js +3 -3
- package/dist-types/Health.d.ts +71 -76
- package/dist-types/HealthClient.d.ts +27 -19
- 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 +8 -10
- 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 +11 -11
- package/dist-types/commands/DescribeEventTypesCommand.d.ts +2 -2
- 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 +9 -10
- package/dist-types/commands/EnableHealthServiceAccessForOrganizationCommand.d.ts +8 -8
- package/dist-types/models/models_0.d.ts +67 -61
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/HealthClient.d.ts +4 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +23 -23
|
@@ -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 the
|
|
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 the
|
|
12
|
+
* 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
32
|
* organization, you must specify the <code>awsAccountId</code> parameter in the
|
|
33
|
-
* request. If you don't specify an account ID,
|
|
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,7 +8,7 @@ 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
14
|
* particular order. </p>
|
|
@@ -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,19 @@ 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
|
-
* <i>
|
|
14
|
-
* <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or
|
|
12
|
+
* Health events</a> in the
|
|
13
|
+
* <i>Health User Guide</i>.</p>
|
|
14
|
+
* <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or Command Line Interface (CLI) to
|
|
15
15
|
* remove the 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 Amazon Web Services account.</p>
|
|
23
22
|
* </note>
|
|
24
23
|
* @example
|
|
25
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -33,7 +32,7 @@ export interface DisableHealthServiceAccessForOrganizationCommandOutput extends
|
|
|
33
32
|
*
|
|
34
33
|
* @see {@link DisableHealthServiceAccessForOrganizationCommandInput} for command's `input` shape.
|
|
35
34
|
* @see {@link DisableHealthServiceAccessForOrganizationCommandOutput} for command's `response` shape.
|
|
36
|
-
* @see {@link HealthClientResolvedConfig | config} for
|
|
35
|
+
* @see {@link HealthClientResolvedConfig | config} for HealthClient's `config` shape.
|
|
37
36
|
*
|
|
38
37
|
*/
|
|
39
38
|
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
|
|
17
|
+
* <p>You must have a Business 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
19
|
* Business 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> {
|
|
@@ -34,7 +34,7 @@ export interface AffectedEntity {
|
|
|
34
34
|
*/
|
|
35
35
|
entityUrl?: string;
|
|
36
36
|
/**
|
|
37
|
-
* <p>The 12-digit
|
|
37
|
+
* <p>The 12-digit Amazon Web Services account number that contains the affected entity.</p>
|
|
38
38
|
*/
|
|
39
39
|
awsAccountId?: string;
|
|
40
40
|
/**
|
|
@@ -103,7 +103,7 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
|
|
|
103
103
|
*/
|
|
104
104
|
affectedAccounts?: string[];
|
|
105
105
|
/**
|
|
106
|
-
* <p>This parameter specifies if the
|
|
106
|
+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
|
|
107
107
|
* <ul>
|
|
108
108
|
* <li>
|
|
109
109
|
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
|
|
@@ -111,9 +111,9 @@ export interface DescribeAffectedAccountsForOrganizationResponse {
|
|
|
111
111
|
* </li>
|
|
112
112
|
* <li>
|
|
113
113
|
* <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
|
|
114
|
-
* the <code>affectedAccounts</code> value lists the affected
|
|
114
|
+
* the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
|
|
115
115
|
* organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
|
|
116
|
-
* have
|
|
116
|
+
* have Amazon Web Services accounts that use that service, those account IDs appear in the
|
|
117
117
|
* response.</p>
|
|
118
118
|
* </li>
|
|
119
119
|
* <li>
|
|
@@ -178,7 +178,7 @@ export declare namespace DateTimeRange {
|
|
|
178
178
|
const filterSensitiveLog: (obj: DateTimeRange) => any;
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
|
-
* <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/
|
|
181
|
+
* <p>The values to use to filter results from the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html">DescribeAffectedEntities</a>
|
|
182
182
|
* operation.</p>
|
|
183
183
|
*/
|
|
184
184
|
export interface EntityFilter {
|
|
@@ -296,7 +296,7 @@ export interface EventAccountFilter {
|
|
|
296
296
|
*/
|
|
297
297
|
eventArn: string | undefined;
|
|
298
298
|
/**
|
|
299
|
-
* <p>The 12-digit
|
|
299
|
+
* <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
|
|
300
300
|
*/
|
|
301
301
|
awsAccountId?: string;
|
|
302
302
|
}
|
|
@@ -340,7 +340,7 @@ export declare namespace DescribeAffectedEntitiesForOrganizationRequest {
|
|
|
340
340
|
*/
|
|
341
341
|
export interface OrganizationAffectedEntitiesErrorItem {
|
|
342
342
|
/**
|
|
343
|
-
* <p>The 12-digit
|
|
343
|
+
* <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
|
|
344
344
|
*/
|
|
345
345
|
awsAccountId?: string;
|
|
346
346
|
/**
|
|
@@ -478,15 +478,15 @@ export interface EventFilter {
|
|
|
478
478
|
*/
|
|
479
479
|
eventTypeCodes?: string[];
|
|
480
480
|
/**
|
|
481
|
-
* <p>The
|
|
481
|
+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
|
|
482
482
|
*/
|
|
483
483
|
services?: string[];
|
|
484
484
|
/**
|
|
485
|
-
* <p>A list of
|
|
485
|
+
* <p>A list of Amazon Web Services Regions.</p>
|
|
486
486
|
*/
|
|
487
487
|
regions?: string[];
|
|
488
488
|
/**
|
|
489
|
-
* <p>A list of
|
|
489
|
+
* <p>A list of Amazon Web Services Availability Zones.</p>
|
|
490
490
|
*/
|
|
491
491
|
availabilityZones?: string[];
|
|
492
492
|
/**
|
|
@@ -511,8 +511,9 @@ export interface EventFilter {
|
|
|
511
511
|
*/
|
|
512
512
|
entityValues?: string[];
|
|
513
513
|
/**
|
|
514
|
-
* <p>A list of event type category codes
|
|
515
|
-
*
|
|
514
|
+
* <p>A list of event type category codes. Possible values are
|
|
515
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
516
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
516
517
|
*/
|
|
517
518
|
eventTypeCategories?: (EventTypeCategory | string)[];
|
|
518
519
|
/**
|
|
@@ -648,21 +649,20 @@ export declare namespace EventDetailsErrorItem {
|
|
|
648
649
|
const filterSensitiveLog: (obj: EventDetailsErrorItem) => any;
|
|
649
650
|
}
|
|
650
651
|
/**
|
|
651
|
-
* <p>Summary information about an
|
|
652
|
-
* <p>
|
|
652
|
+
* <p>Summary information about an Health event.</p>
|
|
653
|
+
* <p>Health events can be public or account-specific:</p>
|
|
653
654
|
* <ul>
|
|
654
655
|
* <li>
|
|
655
656
|
* <p>
|
|
656
657
|
* <i>Public events</i> might be service events that are not specific
|
|
657
|
-
* to an
|
|
658
|
-
*
|
|
658
|
+
* to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,
|
|
659
|
+
* Health provides information about the event, even if you don't use services or
|
|
659
660
|
* resources in that Region.</p>
|
|
660
661
|
* </li>
|
|
661
662
|
* <li>
|
|
662
663
|
* <p>
|
|
663
|
-
* <i>Account-specific</i> events are specific to either your
|
|
664
|
-
*
|
|
665
|
-
* Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
|
|
664
|
+
* <i>Account-specific</i> events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with
|
|
665
|
+
* Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event
|
|
666
666
|
* and the affected resources in the account.</p>
|
|
667
667
|
* </li>
|
|
668
668
|
* </ul>
|
|
@@ -682,7 +682,7 @@ export interface Event {
|
|
|
682
682
|
*/
|
|
683
683
|
arn?: string;
|
|
684
684
|
/**
|
|
685
|
-
* <p>The
|
|
685
|
+
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
|
|
686
686
|
*/
|
|
687
687
|
service?: string;
|
|
688
688
|
/**
|
|
@@ -691,16 +691,17 @@ export interface Event {
|
|
|
691
691
|
*/
|
|
692
692
|
eventTypeCode?: string;
|
|
693
693
|
/**
|
|
694
|
-
* <p>
|
|
695
|
-
*
|
|
694
|
+
* <p>A list of event type category codes. Possible values are
|
|
695
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
696
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
696
697
|
*/
|
|
697
698
|
eventTypeCategory?: EventTypeCategory | string;
|
|
698
699
|
/**
|
|
699
|
-
* <p>The
|
|
700
|
+
* <p>The Amazon Web Services Region name of the event.</p>
|
|
700
701
|
*/
|
|
701
702
|
region?: string;
|
|
702
703
|
/**
|
|
703
|
-
* <p>The
|
|
704
|
+
* <p>The Amazon Web Services Availability Zone of the event. For example, us-east-1a.</p>
|
|
704
705
|
*/
|
|
705
706
|
availabilityZone?: string;
|
|
706
707
|
/**
|
|
@@ -721,7 +722,7 @@ export interface Event {
|
|
|
721
722
|
*/
|
|
722
723
|
statusCode?: EventStatusCode | string;
|
|
723
724
|
/**
|
|
724
|
-
* <p>This parameter specifies if the
|
|
725
|
+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
|
|
725
726
|
* <ul>
|
|
726
727
|
* <li>
|
|
727
728
|
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
|
|
@@ -729,9 +730,9 @@ export interface Event {
|
|
|
729
730
|
* </li>
|
|
730
731
|
* <li>
|
|
731
732
|
* <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
|
|
732
|
-
* the <code>affectedAccounts</code> value lists the affected
|
|
733
|
+
* the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
|
|
733
734
|
* organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
|
|
734
|
-
* have
|
|
735
|
+
* have Amazon Web Services accounts that use that service, those account IDs appear in the
|
|
735
736
|
* response.</p>
|
|
736
737
|
* </li>
|
|
737
738
|
* <li>
|
|
@@ -851,17 +852,16 @@ export interface OrganizationEventDetailsErrorItem {
|
|
|
851
852
|
errorName?: string;
|
|
852
853
|
/**
|
|
853
854
|
* <p>A message that describes the error.</p>
|
|
854
|
-
* <p>If you call the <code>DescribeEventDetailsForOrganization</code>
|
|
855
|
-
* operation and receive one of the following errors, follow the recommendations in the message:</p>
|
|
855
|
+
* <p>If you call the <code>DescribeEventDetailsForOrganization</code> operation and receive one of the following errors, follow the recommendations in the message:</p>
|
|
856
856
|
* <ul>
|
|
857
857
|
* <li>
|
|
858
|
-
* <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an
|
|
858
|
+
* <p>We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an Amazon Web Services account ID in the request.</p>
|
|
859
859
|
* </li>
|
|
860
860
|
* <li>
|
|
861
|
-
* <p>We couldn't find an account specific event for the specified
|
|
861
|
+
* <p>We couldn't find an account specific event for the specified Amazon Web Services account. To find an event that is public, you must enter a null value for the Amazon Web Services account ID in the request.</p>
|
|
862
862
|
* </li>
|
|
863
863
|
* <li>
|
|
864
|
-
* <p>Your
|
|
864
|
+
* <p>Your Amazon Web Services account doesn't include the Amazon Web Services Support plan required to use the Health API. You must have either a Business or Enterprise Support plan.</p>
|
|
865
865
|
* </li>
|
|
866
866
|
* </ul>
|
|
867
867
|
*/
|
|
@@ -879,25 +879,24 @@ export declare namespace OrganizationEventDetailsErrorItem {
|
|
|
879
879
|
*/
|
|
880
880
|
export interface OrganizationEventDetails {
|
|
881
881
|
/**
|
|
882
|
-
* <p>The 12-digit
|
|
882
|
+
* <p>The 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
|
|
883
883
|
*/
|
|
884
884
|
awsAccountId?: string;
|
|
885
885
|
/**
|
|
886
|
-
* <p>Summary information about an
|
|
887
|
-
* <p>
|
|
886
|
+
* <p>Summary information about an Health event.</p>
|
|
887
|
+
* <p>Health events can be public or account-specific:</p>
|
|
888
888
|
* <ul>
|
|
889
889
|
* <li>
|
|
890
890
|
* <p>
|
|
891
891
|
* <i>Public events</i> might be service events that are not specific
|
|
892
|
-
* to an
|
|
893
|
-
*
|
|
892
|
+
* to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region,
|
|
893
|
+
* Health provides information about the event, even if you don't use services or
|
|
894
894
|
* resources in that Region.</p>
|
|
895
895
|
* </li>
|
|
896
896
|
* <li>
|
|
897
897
|
* <p>
|
|
898
|
-
* <i>Account-specific</i> events are specific to either your
|
|
899
|
-
*
|
|
900
|
-
* Amazon Elastic Compute Cloud in a Region that you use, AWS Health provides information about the event
|
|
898
|
+
* <i>Account-specific</i> events are specific to either your Amazon Web Services account or an account in your organization. For example, if there's an issue with
|
|
899
|
+
* Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event
|
|
901
900
|
* and the affected resources in the account.</p>
|
|
902
901
|
* </li>
|
|
903
902
|
* </ul>
|
|
@@ -995,15 +994,15 @@ export interface OrganizationEventFilter {
|
|
|
995
994
|
*/
|
|
996
995
|
eventTypeCodes?: string[];
|
|
997
996
|
/**
|
|
998
|
-
* <p>A list of 12-digit
|
|
997
|
+
* <p>A list of 12-digit Amazon Web Services account numbers that contains the affected entities.</p>
|
|
999
998
|
*/
|
|
1000
999
|
awsAccountIds?: string[];
|
|
1001
1000
|
/**
|
|
1002
|
-
* <p>The
|
|
1001
|
+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
|
|
1003
1002
|
*/
|
|
1004
1003
|
services?: string[];
|
|
1005
1004
|
/**
|
|
1006
|
-
* <p>A list of
|
|
1005
|
+
* <p>A list of Amazon Web Services Regions.</p>
|
|
1007
1006
|
*/
|
|
1008
1007
|
regions?: string[];
|
|
1009
1008
|
/**
|
|
@@ -1045,7 +1044,9 @@ export interface OrganizationEventFilter {
|
|
|
1045
1044
|
*/
|
|
1046
1045
|
entityValues?: string[];
|
|
1047
1046
|
/**
|
|
1048
|
-
* <p>A list of event type category codes
|
|
1047
|
+
* <p>A list of event type category codes. Possible values are
|
|
1048
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
1049
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
1049
1050
|
*/
|
|
1050
1051
|
eventTypeCategories?: (EventTypeCategory | string)[];
|
|
1051
1052
|
/**
|
|
@@ -1102,7 +1103,7 @@ export interface OrganizationEvent {
|
|
|
1102
1103
|
*/
|
|
1103
1104
|
arn?: string;
|
|
1104
1105
|
/**
|
|
1105
|
-
* <p>The
|
|
1106
|
+
* <p>The Amazon Web Services service that is affected by the event, such as EC2 and RDS.</p>
|
|
1106
1107
|
*/
|
|
1107
1108
|
service?: string;
|
|
1108
1109
|
/**
|
|
@@ -1112,11 +1113,13 @@ export interface OrganizationEvent {
|
|
|
1112
1113
|
*/
|
|
1113
1114
|
eventTypeCode?: string;
|
|
1114
1115
|
/**
|
|
1115
|
-
* <p>
|
|
1116
|
+
* <p>A list of event type category codes. Possible values are
|
|
1117
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
1118
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
1116
1119
|
*/
|
|
1117
1120
|
eventTypeCategory?: EventTypeCategory | string;
|
|
1118
1121
|
/**
|
|
1119
|
-
* <p>This parameter specifies if the
|
|
1122
|
+
* <p>This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.</p>
|
|
1120
1123
|
* <ul>
|
|
1121
1124
|
* <li>
|
|
1122
1125
|
* <p>If the <code>eventScopeCode</code> value is <code>PUBLIC</code>, then the
|
|
@@ -1124,9 +1127,9 @@ export interface OrganizationEvent {
|
|
|
1124
1127
|
* </li>
|
|
1125
1128
|
* <li>
|
|
1126
1129
|
* <p>If the <code>eventScopeCode</code> value is <code>ACCOUNT_SPECIFIC</code>, then
|
|
1127
|
-
* the <code>affectedAccounts</code> value lists the affected
|
|
1130
|
+
* the <code>affectedAccounts</code> value lists the affected Amazon Web Services accounts in your
|
|
1128
1131
|
* organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you
|
|
1129
|
-
* have
|
|
1132
|
+
* have Amazon Web Services accounts that use that service, those account IDs appear in the
|
|
1130
1133
|
* response.</p>
|
|
1131
1134
|
* </li>
|
|
1132
1135
|
* <li>
|
|
@@ -1138,7 +1141,7 @@ export interface OrganizationEvent {
|
|
|
1138
1141
|
*/
|
|
1139
1142
|
eventScopeCode?: EventScopeCode | string;
|
|
1140
1143
|
/**
|
|
1141
|
-
* <p>The
|
|
1144
|
+
* <p>The Amazon Web Services Region name of the event.</p>
|
|
1142
1145
|
*/
|
|
1143
1146
|
region?: string;
|
|
1144
1147
|
/**
|
|
@@ -1194,12 +1197,13 @@ export interface EventTypeFilter {
|
|
|
1194
1197
|
*/
|
|
1195
1198
|
eventTypeCodes?: string[];
|
|
1196
1199
|
/**
|
|
1197
|
-
* <p>The
|
|
1200
|
+
* <p>The Amazon Web Services services associated with the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
|
|
1198
1201
|
*/
|
|
1199
1202
|
services?: string[];
|
|
1200
1203
|
/**
|
|
1201
|
-
* <p>A list of event type category codes
|
|
1202
|
-
*
|
|
1204
|
+
* <p>A list of event type category codes. Possible values are
|
|
1205
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
1206
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
1203
1207
|
*/
|
|
1204
1208
|
eventTypeCategories?: (EventTypeCategory | string)[];
|
|
1205
1209
|
}
|
|
@@ -1237,20 +1241,20 @@ export declare namespace DescribeEventTypesRequest {
|
|
|
1237
1241
|
const filterSensitiveLog: (obj: DescribeEventTypesRequest) => any;
|
|
1238
1242
|
}
|
|
1239
1243
|
/**
|
|
1240
|
-
* <p>Contains the metadata about a type of event that is reported by
|
|
1244
|
+
* <p>Contains the metadata about a type of event that is reported by Health. The
|
|
1241
1245
|
* <code>EventType</code> shows the category, service, and the event type code of the
|
|
1242
1246
|
* event. For example, an <code>issue</code> might be the category, <code>EC2</code> the
|
|
1243
1247
|
* service, and <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code> the event type code.</p>
|
|
1244
1248
|
* <p>You can use the <a href="https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html">DescribeEventTypes</a> API operation to return this information
|
|
1245
1249
|
* about an event.</p>
|
|
1246
1250
|
* <p>You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or
|
|
1247
|
-
* take action when
|
|
1248
|
-
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for
|
|
1249
|
-
* <i>
|
|
1251
|
+
* take action when Health delivers a specific event to your Amazon Web Services account. For more
|
|
1252
|
+
* information, see <a href="https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html">Monitor for Health events with Amazon CloudWatch Events</a> in the
|
|
1253
|
+
* <i>Health User Guide</i>.</p>
|
|
1250
1254
|
*/
|
|
1251
1255
|
export interface EventType {
|
|
1252
1256
|
/**
|
|
1253
|
-
* <p>The
|
|
1257
|
+
* <p>The Amazon Web Services service that is affected by the event. For example, <code>EC2</code>, <code>RDS</code>.</p>
|
|
1254
1258
|
*/
|
|
1255
1259
|
service?: string;
|
|
1256
1260
|
/**
|
|
@@ -1259,8 +1263,9 @@ export interface EventType {
|
|
|
1259
1263
|
*/
|
|
1260
1264
|
code?: string;
|
|
1261
1265
|
/**
|
|
1262
|
-
* <p>A list of event type category codes
|
|
1263
|
-
*
|
|
1266
|
+
* <p>A list of event type category codes. Possible values are
|
|
1267
|
+
* <code>issue</code>, <code>accountNotification</code>, or <code>scheduledChange</code>. Currently,
|
|
1268
|
+
* the <code>investigation</code> value isn't supported at this time.</p>
|
|
1264
1269
|
*/
|
|
1265
1270
|
category?: EventTypeCategory | string;
|
|
1266
1271
|
}
|
|
@@ -1297,7 +1302,8 @@ export declare namespace DescribeEventTypesResponse {
|
|
|
1297
1302
|
}
|
|
1298
1303
|
export interface DescribeHealthServiceStatusForOrganizationResponse {
|
|
1299
1304
|
/**
|
|
1300
|
-
* <p>Information about the status of enabling or disabling
|
|
1305
|
+
* <p>Information about the status of enabling or disabling the Health organizational
|
|
1306
|
+
* view feature in
|
|
1301
1307
|
* your organization.</p>
|
|
1302
1308
|
* <p>Valid values are <code>ENABLED | DISABLED | PENDING</code>. </p>
|
|
1303
1309
|
*/
|
|
@@ -16,6 +16,8 @@ export declare const getRuntimeConfig: (config: HealthClientConfig) => {
|
|
|
16
16
|
retryMode: string | import("@aws-sdk/types").Provider<string>;
|
|
17
17
|
sha256: import("@aws-sdk/types").HashConstructor;
|
|
18
18
|
streamCollector: import("@aws-sdk/types").StreamCollector;
|
|
19
|
+
useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
20
|
+
useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
19
21
|
utf8Decoder: import("@aws-sdk/types").Decoder;
|
|
20
22
|
utf8Encoder: import("@aws-sdk/types").Encoder;
|
|
21
23
|
apiVersion: string;
|
|
@@ -16,6 +16,8 @@ export declare const getRuntimeConfig: (config: HealthClientConfig) => {
|
|
|
16
16
|
retryMode: string | import("@aws-sdk/types").Provider<string>;
|
|
17
17
|
sha256: import("@aws-sdk/types").HashConstructor;
|
|
18
18
|
streamCollector: import("@aws-sdk/types").StreamCollector;
|
|
19
|
+
useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
20
|
+
useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
19
21
|
utf8Decoder: import("@aws-sdk/types").Decoder;
|
|
20
22
|
utf8Encoder: import("@aws-sdk/types").Encoder;
|
|
21
23
|
apiVersion: string;
|