/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / health.d.ts
health.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class Health extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: Health.Types.ClientConfiguration) 13 config: Config & Health.Types.ClientConfiguration; 14 /** 15 * Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 16 */ 17 describeAffectedAccountsForOrganization(params: Health.Types.DescribeAffectedAccountsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedAccountsForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedAccountsForOrganizationResponse, AWSError>; 18 /** 19 * Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 20 */ 21 describeAffectedAccountsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedAccountsForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedAccountsForOrganizationResponse, AWSError>; 22 /** 23 * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 24 */ 25 describeAffectedEntities(params: Health.Types.DescribeAffectedEntitiesRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>; 26 /** 27 * Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this. At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 28 */ 29 describeAffectedEntities(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesResponse) => void): Request<Health.Types.DescribeAffectedEntitiesResponse, AWSError>; 30 /** 31 * Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. 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 AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 32 */ 33 describeAffectedEntitiesForOrganization(params: Health.Types.DescribeAffectedEntitiesForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>; 34 /** 35 * Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. 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 AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 36 */ 37 describeAffectedEntitiesForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeAffectedEntitiesForOrganizationResponse) => void): Request<Health.Types.DescribeAffectedEntitiesForOrganizationResponse, AWSError>; 38 /** 39 * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned. 40 */ 41 describeEntityAggregates(params: Health.Types.DescribeEntityAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>; 42 /** 43 * Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned. 44 */ 45 describeEntityAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEntityAggregatesResponse) => void): Request<Health.Types.DescribeEntityAggregatesResponse, AWSError>; 46 /** 47 * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 48 */ 49 describeEventAggregates(params: Health.Types.DescribeEventAggregatesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>; 50 /** 51 * Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 52 */ 53 describeEventAggregates(callback?: (err: AWSError, data: Health.Types.DescribeEventAggregatesResponse) => void): Request<Health.Types.DescribeEventAggregatesResponse, AWSError>; 54 /** 55 * Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation. If a specified event can't be retrieved, an error message is returned for that event. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 56 */ 57 describeEventDetails(params: Health.Types.DescribeEventDetailsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>; 58 /** 59 * Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve the entities, use the DescribeAffectedEntities operation. If a specified event can't be retrieved, an error message is returned for that event. This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 60 */ 61 describeEventDetails(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsResponse) => void): Request<Health.Types.DescribeEventDetailsResponse, AWSError>; 62 /** 63 * Returns detailed information about one or more specified events for one or more AWS accounts in your organization. This information includes standard event data (such as the AWS Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences: To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, AWS Health returns an error message because public events aren't specific to an account. To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, AWS Health returns an error message because the event is specific to an account in your organization. For more information, see Event. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 64 */ 65 describeEventDetailsForOrganization(params: Health.Types.DescribeEventDetailsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsForOrganizationResponse) => void): Request<Health.Types.DescribeEventDetailsForOrganizationResponse, AWSError>; 66 /** 67 * Returns detailed information about one or more specified events for one or more AWS accounts in your organization. This information includes standard event data (such as the AWS Region and service), an event description, and (depending on the event) possible metadata. This operation doesn't return affected entities, such as the resources related to the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. When you call the DescribeEventDetailsForOrganization operation, specify the organizationEventDetailFilters object in the request. Depending on the AWS Health event type, note the following differences: To return event details for a public event, you must specify a null value for the awsAccountId parameter. If you specify an account ID for a public event, AWS Health returns an error message because public events aren't specific to an account. To return event details for an event that is specific to an account in your organization, you must specify the awsAccountId parameter in the request. If you don't specify an account ID, AWS Health returns an error message because the event is specific to an account in your organization. For more information, see Event. This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see Resource- and action-based conditions in the AWS Health User Guide. 68 */ 69 describeEventDetailsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventDetailsForOrganizationResponse) => void): Request<Health.Types.DescribeEventDetailsForOrganizationResponse, AWSError>; 70 /** 71 * Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 72 */ 73 describeEventTypes(params: Health.Types.DescribeEventTypesRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>; 74 /** 75 * Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object. If you don't specify a filter criteria, the API operation returns all event types, in no particular order. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 76 */ 77 describeEventTypes(callback?: (err: AWSError, data: Health.Types.DescribeEventTypesResponse) => void): Request<Health.Types.DescribeEventTypesResponse, AWSError>; 78 /** 79 * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 80 */ 81 describeEvents(params: Health.Types.DescribeEventsRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>; 82 /** 83 * Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations. If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent event. When you call the DescribeEvents operation and specify an entity for the entityValues parameter, AWS Health might return public events that aren't specific to that resource. For example, if you call DescribeEvents and specify an ID for an Amazon Elastic Compute Cloud (Amazon EC2) instance, AWS Health might return events that aren't specific to that resource or service. To get events that are specific to a service, use the services parameter in the filter object. For more information, see Event. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 84 */ 85 describeEvents(callback?: (err: AWSError, data: Health.Types.DescribeEventsResponse) => void): Request<Health.Types.DescribeEventsResponse, AWSError>; 86 /** 87 * Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 88 */ 89 describeEventsForOrganization(params: Health.Types.DescribeEventsForOrganizationRequest, callback?: (err: AWSError, data: Health.Types.DescribeEventsForOrganizationResponse) => void): Request<Health.Types.DescribeEventsForOrganizationResponse, AWSError>; 90 /** 91 * Returns information about events across your organization in AWS Organizations. You can use thefilters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations: DescribeAffectedAccountsForOrganization DescribeEventDetailsForOrganization DescribeAffectedEntitiesForOrganization If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event. For more information about the different types of AWS Health events, see Event. Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account. This API operation uses pagination. Specify the nextToken parameter in the next request to return more results. 92 */ 93 describeEventsForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeEventsForOrganizationResponse) => void): Request<Health.Types.DescribeEventsForOrganizationResponse, AWSError>; 94 /** 95 * This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. 96 */ 97 describeHealthServiceStatusForOrganization(callback?: (err: AWSError, data: Health.Types.DescribeHealthServiceStatusForOrganizationResponse) => void): Request<Health.Types.DescribeHealthServiceStatusForOrganizationResponse, AWSError>; 98 /** 99 * Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see Aggregating AWS Health events in the AWS Health User Guide. This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account. 100 */ 101 disableHealthServiceAccessForOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 102 /** 103 * Enables AWS Health to work with AWS Organizations. You can use the organizational view feature to aggregate events from all AWS accounts in your organization in a centralized location. This operation also creates a service-linked role for the management account in the organization. To call this operation, you must meet the following requirements: You must have a Business or Enterprise Support plan from AWS Support to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise Support plan, you receive a SubscriptionRequiredException error. You must have permission to call this operation from the organization's management account. For example IAM policies, see AWS Health identity-based policy examples. If you don't have the required support plan, you can instead use the AWS Health console to enable the organizational view feature. For more information, see Aggregating AWS Health events in the AWS Health User Guide. 104 */ 105 enableHealthServiceAccessForOrganization(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 106 } 107 declare namespace Health { 108 export interface AffectedEntity { 109 /** 110 * 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 111 */ 112 entityArn?: entityArn; 113 /** 114 * 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 115 */ 116 eventArn?: eventArn; 117 /** 118 * The ID of the affected entity. 119 */ 120 entityValue?: entityValue; 121 /** 122 * The URL of the affected entity. 123 */ 124 entityUrl?: entityUrl; 125 /** 126 * The 12-digit AWS account number that contains the affected entity. 127 */ 128 awsAccountId?: accountId; 129 /** 130 * The most recent time that the entity was updated. 131 */ 132 lastUpdatedTime?: timestamp; 133 /** 134 * The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN. 135 */ 136 statusCode?: entityStatusCode; 137 /** 138 * A map of entity tags attached to the affected entity. Currently, the tags property isn't supported. 139 */ 140 tags?: tagSet; 141 } 142 export interface DateTimeRange { 143 /** 144 * The starting date and time of a time range. 145 */ 146 from?: timestamp; 147 /** 148 * The ending date and time of a time range. 149 */ 150 to?: timestamp; 151 } 152 export interface DescribeAffectedAccountsForOrganizationRequest { 153 /** 154 * 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 155 */ 156 eventArn: eventArn; 157 /** 158 * 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. 159 */ 160 nextToken?: nextToken; 161 /** 162 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 163 */ 164 maxResults?: maxResults; 165 } 166 export interface DescribeAffectedAccountsForOrganizationResponse { 167 /** 168 * A JSON set of elements of the affected accounts. 169 */ 170 affectedAccounts?: affectedAccountsList; 171 /** 172 * This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist. 173 */ 174 eventScopeCode?: eventScopeCode; 175 /** 176 * 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. 177 */ 178 nextToken?: nextToken; 179 } 180 export type DescribeAffectedEntitiesForOrganizationFailedSet = OrganizationAffectedEntitiesErrorItem[]; 181 export interface DescribeAffectedEntitiesForOrganizationRequest { 182 /** 183 * A JSON set of elements including the awsAccountId and the eventArn. 184 */ 185 organizationEntityFilters: OrganizationEntityFiltersList; 186 /** 187 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 188 */ 189 locale?: locale; 190 /** 191 * 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. 192 */ 193 nextToken?: nextToken; 194 /** 195 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 196 */ 197 maxResults?: maxResultsLowerRange; 198 } 199 export interface DescribeAffectedEntitiesForOrganizationResponse { 200 /** 201 * A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode. 202 */ 203 entities?: EntityList; 204 /** 205 * A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn. 206 */ 207 failedSet?: DescribeAffectedEntitiesForOrganizationFailedSet; 208 /** 209 * 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. 210 */ 211 nextToken?: nextToken; 212 } 213 export interface DescribeAffectedEntitiesRequest { 214 /** 215 * Values to narrow the results returned. At least one event ARN is required. 216 */ 217 filter: EntityFilter; 218 /** 219 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 220 */ 221 locale?: locale; 222 /** 223 * 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. 224 */ 225 nextToken?: nextToken; 226 /** 227 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 228 */ 229 maxResults?: maxResults; 230 } 231 export interface DescribeAffectedEntitiesResponse { 232 /** 233 * The entities that match the filter criteria. 234 */ 235 entities?: EntityList; 236 /** 237 * 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. 238 */ 239 nextToken?: nextToken; 240 } 241 export interface DescribeEntityAggregatesRequest { 242 /** 243 * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" 244 */ 245 eventArns?: EventArnsList; 246 } 247 export interface DescribeEntityAggregatesResponse { 248 /** 249 * The number of entities that are affected by each of the specified events. 250 */ 251 entityAggregates?: EntityAggregateList; 252 } 253 export interface DescribeEventAggregatesRequest { 254 /** 255 * Values to narrow the results returned. 256 */ 257 filter?: EventFilter; 258 /** 259 * The only currently supported value is eventTypeCategory. 260 */ 261 aggregateField: eventAggregateField; 262 /** 263 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 264 */ 265 maxResults?: maxResults; 266 /** 267 * 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. 268 */ 269 nextToken?: nextToken; 270 } 271 export interface DescribeEventAggregatesResponse { 272 /** 273 * The number of events in each category that meet the optional filter criteria. 274 */ 275 eventAggregates?: EventAggregateList; 276 /** 277 * 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. 278 */ 279 nextToken?: nextToken; 280 } 281 export type DescribeEventDetailsFailedSet = EventDetailsErrorItem[]; 282 export type DescribeEventDetailsForOrganizationFailedSet = OrganizationEventDetailsErrorItem[]; 283 export interface DescribeEventDetailsForOrganizationRequest { 284 /** 285 * A set of JSON elements that includes the awsAccountId and the eventArn. 286 */ 287 organizationEventDetailFilters: OrganizationEventDetailFiltersList; 288 /** 289 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 290 */ 291 locale?: locale; 292 } 293 export interface DescribeEventDetailsForOrganizationResponse { 294 /** 295 * Information about the events that could be retrieved. 296 */ 297 successfulSet?: DescribeEventDetailsForOrganizationSuccessfulSet; 298 /** 299 * Error messages for any events that could not be retrieved. 300 */ 301 failedSet?: DescribeEventDetailsForOrganizationFailedSet; 302 } 303 export type DescribeEventDetailsForOrganizationSuccessfulSet = OrganizationEventDetails[]; 304 export interface DescribeEventDetailsRequest { 305 /** 306 * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" 307 */ 308 eventArns: eventArnList; 309 /** 310 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 311 */ 312 locale?: locale; 313 } 314 export interface DescribeEventDetailsResponse { 315 /** 316 * Information about the events that could be retrieved. 317 */ 318 successfulSet?: DescribeEventDetailsSuccessfulSet; 319 /** 320 * Error messages for any events that could not be retrieved. 321 */ 322 failedSet?: DescribeEventDetailsFailedSet; 323 } 324 export type DescribeEventDetailsSuccessfulSet = EventDetails[]; 325 export interface DescribeEventTypesRequest { 326 /** 327 * Values to narrow the results returned. 328 */ 329 filter?: EventTypeFilter; 330 /** 331 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 332 */ 333 locale?: locale; 334 /** 335 * 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. 336 */ 337 nextToken?: nextToken; 338 /** 339 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 340 */ 341 maxResults?: maxResults; 342 } 343 export interface DescribeEventTypesResponse { 344 /** 345 * A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT). 346 */ 347 eventTypes?: EventTypeList; 348 /** 349 * 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. 350 */ 351 nextToken?: nextToken; 352 } 353 export interface DescribeEventsForOrganizationRequest { 354 /** 355 * Values to narrow the results returned. 356 */ 357 filter?: OrganizationEventFilter; 358 /** 359 * 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. 360 */ 361 nextToken?: nextToken; 362 /** 363 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 364 */ 365 maxResults?: maxResultsLowerRange; 366 /** 367 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 368 */ 369 locale?: locale; 370 } 371 export interface DescribeEventsForOrganizationResponse { 372 /** 373 * The events that match the specified filter criteria. 374 */ 375 events?: OrganizationEventList; 376 /** 377 * 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. 378 */ 379 nextToken?: nextToken; 380 } 381 export interface DescribeEventsRequest { 382 /** 383 * Values to narrow the results returned. 384 */ 385 filter?: EventFilter; 386 /** 387 * 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. 388 */ 389 nextToken?: nextToken; 390 /** 391 * The maximum number of items to return in one batch, between 10 and 100, inclusive. 392 */ 393 maxResults?: maxResults; 394 /** 395 * The locale (language) to return information in. English (en) is the default and the only supported value at this time. 396 */ 397 locale?: locale; 398 } 399 export interface DescribeEventsResponse { 400 /** 401 * The events that match the specified filter criteria. 402 */ 403 events?: EventList; 404 /** 405 * 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. 406 */ 407 nextToken?: nextToken; 408 } 409 export interface DescribeHealthServiceStatusForOrganizationResponse { 410 /** 411 * Information about the status of enabling or disabling AWS Health Organizational View in your organization. Valid values are ENABLED | DISABLED | PENDING. 412 */ 413 healthServiceAccessStatusForOrganization?: healthServiceAccessStatusForOrganization; 414 } 415 export interface EntityAggregate { 416 /** 417 * 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 418 */ 419 eventArn?: eventArn; 420 /** 421 * The number of entities that match the criteria for the specified events. 422 */ 423 count?: count; 424 } 425 export type EntityAggregateList = EntityAggregate[]; 426 export interface EntityFilter { 427 /** 428 * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" 429 */ 430 eventArns: eventArnList; 431 /** 432 * A list of entity ARNs (unique identifiers). 433 */ 434 entityArns?: entityArnList; 435 /** 436 * A list of IDs for affected entities. 437 */ 438 entityValues?: entityValueList; 439 /** 440 * A list of the most recent dates and times that the entity was updated. 441 */ 442 lastUpdatedTimes?: dateTimeRangeList; 443 /** 444 * A map of entity tags attached to the affected entity. Currently, the tags property isn't supported. 445 */ 446 tags?: tagFilter; 447 /** 448 * A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN). 449 */ 450 statusCodes?: entityStatusCodeList; 451 } 452 export type EntityList = AffectedEntity[]; 453 export interface Event { 454 /** 455 * 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 456 */ 457 arn?: eventArn; 458 /** 459 * The AWS service that is affected by the event. For example, EC2, RDS. 460 */ 461 service?: service; 462 /** 463 * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. 464 */ 465 eventTypeCode?: eventTypeCode; 466 /** 467 * The category of the event. Possible values are issue, scheduledChange, and accountNotification. 468 */ 469 eventTypeCategory?: eventTypeCategory; 470 /** 471 * The AWS Region name of the event. 472 */ 473 region?: region; 474 /** 475 * The AWS Availability Zone of the event. For example, us-east-1a. 476 */ 477 availabilityZone?: availabilityZone; 478 /** 479 * The date and time that the event began. 480 */ 481 startTime?: timestamp; 482 /** 483 * The date and time that the event ended. 484 */ 485 endTime?: timestamp; 486 /** 487 * The most recent date and time that the event was updated. 488 */ 489 lastUpdatedTime?: timestamp; 490 /** 491 * The most recent status of the event. Possible values are open, closed, and upcoming. 492 */ 493 statusCode?: eventStatusCode; 494 /** 495 * This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist. 496 */ 497 eventScopeCode?: eventScopeCode; 498 } 499 export interface EventAccountFilter { 500 /** 501 * 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 502 */ 503 eventArn: eventArn; 504 /** 505 * The 12-digit AWS account numbers that contains the affected entities. 506 */ 507 awsAccountId?: accountId; 508 } 509 export interface EventAggregate { 510 /** 511 * The issue type for the associated count. 512 */ 513 aggregateValue?: aggregateValue; 514 /** 515 * The number of events of the associated issue type. 516 */ 517 count?: count; 518 } 519 export type EventAggregateList = EventAggregate[]; 520 export type EventArnsList = eventArn[]; 521 export interface EventDescription { 522 /** 523 * The most recent description of the event. 524 */ 525 latestDescription?: eventDescription; 526 } 527 export interface EventDetails { 528 /** 529 * Summary information about the event. 530 */ 531 event?: Event; 532 /** 533 * The most recent description of the event. 534 */ 535 eventDescription?: EventDescription; 536 /** 537 * Additional metadata about the event. 538 */ 539 eventMetadata?: eventMetadata; 540 } 541 export interface EventDetailsErrorItem { 542 /** 543 * 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 544 */ 545 eventArn?: eventArn; 546 /** 547 * The name of the error. 548 */ 549 errorName?: string; 550 /** 551 * A message that describes the error. 552 */ 553 errorMessage?: string; 554 } 555 export interface EventFilter { 556 /** 557 * A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101" 558 */ 559 eventArns?: eventArnList; 560 /** 561 * A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". 562 */ 563 eventTypeCodes?: eventTypeList; 564 /** 565 * The AWS services associated with the event. For example, EC2, RDS. 566 */ 567 services?: serviceList; 568 /** 569 * A list of AWS Regions. 570 */ 571 regions?: regionList; 572 /** 573 * A list of AWS Availability Zones. 574 */ 575 availabilityZones?: availabilityZones; 576 /** 577 * A list of dates and times that the event began. 578 */ 579 startTimes?: dateTimeRangeList; 580 /** 581 * A list of dates and times that the event ended. 582 */ 583 endTimes?: dateTimeRangeList; 584 /** 585 * A list of dates and times that the event was last updated. 586 */ 587 lastUpdatedTimes?: dateTimeRangeList; 588 /** 589 * A list of entity ARNs (unique identifiers). 590 */ 591 entityArns?: entityArnList; 592 /** 593 * A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e). 594 */ 595 entityValues?: entityValueList; 596 /** 597 * A list of event type category codes (issue, scheduledChange, or accountNotification). 598 */ 599 eventTypeCategories?: eventTypeCategoryList; 600 /** 601 * A map of entity tags attached to the affected entity. Currently, the tags property isn't supported. 602 */ 603 tags?: tagFilter; 604 /** 605 * A list of event status codes. 606 */ 607 eventStatusCodes?: eventStatusCodeList; 608 } 609 export type EventList = Event[]; 610 export interface EventType { 611 /** 612 * The AWS service that is affected by the event. For example, EC2, RDS. 613 */ 614 service?: service; 615 /** 616 * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. 617 */ 618 code?: eventTypeCode; 619 /** 620 * A list of event type category codes (issue, scheduledChange, or accountNotification). 621 */ 622 category?: eventTypeCategory; 623 } 624 export type EventTypeCategoryList = eventTypeCategory[]; 625 export type EventTypeCodeList = eventTypeCode[]; 626 export interface EventTypeFilter { 627 /** 628 * A list of event type codes. 629 */ 630 eventTypeCodes?: EventTypeCodeList; 631 /** 632 * The AWS services associated with the event. For example, EC2, RDS. 633 */ 634 services?: serviceList; 635 /** 636 * A list of event type category codes (issue, scheduledChange, or accountNotification). 637 */ 638 eventTypeCategories?: EventTypeCategoryList; 639 } 640 export type EventTypeList = EventType[]; 641 export interface OrganizationAffectedEntitiesErrorItem { 642 /** 643 * The 12-digit AWS account numbers that contains the affected entities. 644 */ 645 awsAccountId?: accountId; 646 /** 647 * 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 648 */ 649 eventArn?: eventArn; 650 /** 651 * The name of the error. 652 */ 653 errorName?: string; 654 /** 655 * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. 656 */ 657 errorMessage?: string; 658 } 659 export type OrganizationEntityFiltersList = EventAccountFilter[]; 660 export interface OrganizationEvent { 661 /** 662 * 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 663 */ 664 arn?: eventArn; 665 /** 666 * The AWS service that is affected by the event, such as EC2 and RDS. 667 */ 668 service?: service; 669 /** 670 * The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT. 671 */ 672 eventTypeCode?: eventTypeCode; 673 /** 674 * The category of the event type. 675 */ 676 eventTypeCategory?: eventTypeCategory; 677 /** 678 * This parameter specifies if the AWS Health event is a public AWS service event or an account-specific event. If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty. If the eventScopeCode value is ACCOUNT_SPECIFIC, then the affectedAccounts value lists the affected AWS accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have AWS accounts that use that service, those account IDs appear in the response. If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist. 679 */ 680 eventScopeCode?: eventScopeCode; 681 /** 682 * The AWS Region name of the event. 683 */ 684 region?: region; 685 /** 686 * The date and time that the event began. 687 */ 688 startTime?: timestamp; 689 /** 690 * The date and time that the event ended. 691 */ 692 endTime?: timestamp; 693 /** 694 * The most recent date and time that the event was updated. 695 */ 696 lastUpdatedTime?: timestamp; 697 /** 698 * The most recent status of the event. Possible values are open, closed, and upcoming. 699 */ 700 statusCode?: eventStatusCode; 701 } 702 export type OrganizationEventDetailFiltersList = EventAccountFilter[]; 703 export interface OrganizationEventDetails { 704 /** 705 * The 12-digit AWS account numbers that contains the affected entities. 706 */ 707 awsAccountId?: accountId; 708 event?: Event; 709 eventDescription?: EventDescription; 710 /** 711 * Additional metadata about the event. 712 */ 713 eventMetadata?: eventMetadata; 714 } 715 export interface OrganizationEventDetailsErrorItem { 716 /** 717 * Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified event. 718 */ 719 awsAccountId?: accountId; 720 /** 721 * 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 722 */ 723 eventArn?: eventArn; 724 /** 725 * The name of the error. 726 */ 727 errorName?: string; 728 /** 729 * A message that describes the error. If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message: We couldn't find a public event that matches your request. To find an event that is account specific, you must enter an AWS account ID in the request. We couldn't find an account specific event for the specified AWS account. To find an event that is public, you must enter a null value for the AWS account ID in the request. Your AWS account doesn't include the AWS Support plan required to use the AWS Health API. You must have either a Business or Enterprise Support plan. 730 */ 731 errorMessage?: string; 732 } 733 export interface OrganizationEventFilter { 734 /** 735 * A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED". 736 */ 737 eventTypeCodes?: eventTypeList; 738 /** 739 * A list of 12-digit AWS account numbers that contains the affected entities. 740 */ 741 awsAccountIds?: awsAccountIdsList; 742 /** 743 * The AWS services associated with the event. For example, EC2, RDS. 744 */ 745 services?: serviceList; 746 /** 747 * A list of AWS Regions. 748 */ 749 regions?: regionList; 750 startTime?: DateTimeRange; 751 endTime?: DateTimeRange; 752 lastUpdatedTime?: DateTimeRange; 753 /** 754 * A list of entity ARNs (unique identifiers). 755 */ 756 entityArns?: entityArnList; 757 /** 758 * A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e). 759 */ 760 entityValues?: entityValueList; 761 /** 762 * A list of event type category codes (issue, scheduledChange, or accountNotification). 763 */ 764 eventTypeCategories?: eventTypeCategoryList; 765 /** 766 * A list of event status codes. 767 */ 768 eventStatusCodes?: eventStatusCodeList; 769 } 770 export type OrganizationEventList = OrganizationEvent[]; 771 export type accountId = string; 772 export type affectedAccountsList = accountId[]; 773 export type aggregateValue = string; 774 export type availabilityZone = string; 775 export type availabilityZones = availabilityZone[]; 776 export type awsAccountIdsList = accountId[]; 777 export type count = number; 778 export type dateTimeRangeList = DateTimeRange[]; 779 export type entityArn = string; 780 export type entityArnList = entityArn[]; 781 export type entityStatusCode = "IMPAIRED"|"UNIMPAIRED"|"UNKNOWN"|string; 782 export type entityStatusCodeList = entityStatusCode[]; 783 export type entityUrl = string; 784 export type entityValue = string; 785 export type entityValueList = entityValue[]; 786 export type eventAggregateField = "eventTypeCategory"|string; 787 export type eventArn = string; 788 export type eventArnList = eventArn[]; 789 export type eventDescription = string; 790 export type eventMetadata = {[key: string]: metadataValue}; 791 export type eventScopeCode = "PUBLIC"|"ACCOUNT_SPECIFIC"|"NONE"|string; 792 export type eventStatusCode = "open"|"closed"|"upcoming"|string; 793 export type eventStatusCodeList = eventStatusCode[]; 794 export type eventType = string; 795 export type eventTypeCategory = "issue"|"accountNotification"|"scheduledChange"|"investigation"|string; 796 export type eventTypeCategoryList = eventTypeCategory[]; 797 export type eventTypeCode = string; 798 export type eventTypeList = eventType[]; 799 export type healthServiceAccessStatusForOrganization = string; 800 export type locale = string; 801 export type maxResults = number; 802 export type maxResultsLowerRange = number; 803 export type metadataKey = string; 804 export type metadataValue = string; 805 export type nextToken = string; 806 export type region = string; 807 export type regionList = region[]; 808 export type service = string; 809 export type serviceList = service[]; 810 export type tagFilter = tagSet[]; 811 export type tagKey = string; 812 export type tagSet = {[key: string]: tagValue}; 813 export type tagValue = string; 814 export type timestamp = Date; 815 /** 816 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 817 */ 818 export type apiVersion = "2016-08-04"|"latest"|string; 819 export interface ClientApiVersions { 820 /** 821 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 822 */ 823 apiVersion?: apiVersion; 824 } 825 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 826 /** 827 * Contains interfaces for use with the Health client. 828 */ 829 export import Types = Health; 830 } 831 export = Health;