{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.health#AWSHealth_20160804": { "type": "service", "version": "2016-08-04", "operations": [ { "target": "com.amazonaws.health#ConfigureTags" }, { "target": "com.amazonaws.health#ConfigureTagsForOrganization" }, { "target": "com.amazonaws.health#DescribeAffectedAccountsForOrganization" }, { "target": "com.amazonaws.health#DescribeAffectedEntities" }, { "target": "com.amazonaws.health#DescribeAffectedEntitiesForOrganization" }, { "target": "com.amazonaws.health#DescribeEntityAggregates" }, { "target": "com.amazonaws.health#DescribeEntityAggregatesForOrganization" }, { "target": "com.amazonaws.health#DescribeEventAggregates" }, { "target": "com.amazonaws.health#DescribeEventDetails" }, { "target": "com.amazonaws.health#DescribeEventDetailsForOrganization" }, { "target": "com.amazonaws.health#DescribeEvents" }, { "target": "com.amazonaws.health#DescribeEventsForOrganization" }, { "target": "com.amazonaws.health#DescribeEventTypes" }, { "target": "com.amazonaws.health#DescribeHealthServiceStatusForOrganization" }, { "target": "com.amazonaws.health#DescribeServiceLifecycle" }, { "target": "com.amazonaws.health#DescribeTagKeys" }, { "target": "com.amazonaws.health#DescribeTagKeysForOrganization" }, { "target": "com.amazonaws.health#DescribeTags" }, { "target": "com.amazonaws.health#DescribeTagsForOrganization" }, { "target": "com.amazonaws.health#DescribeTagsOnboardingStatus" }, { "target": "com.amazonaws.health#DescribeTagsOnboardingStatusForOrganization" }, { "target": "com.amazonaws.health#DisableHealthServiceAccessForOrganization" }, { "target": "com.amazonaws.health#DisableTags" }, { "target": "com.amazonaws.health#DisableTagsForOrganization" }, { "target": "com.amazonaws.health#EnableHealthServiceAccessForOrganization" }, { "target": "com.amazonaws.health#EnableTags" }, { "target": "com.amazonaws.health#EnableTagsForOrganization" } ], "traits": { "aws.api#service": { "sdkId": "Health", "arnNamespace": "health", "cloudFormationName": "Health", "cloudTrailEventSource": "health.amazonaws.com", "endpointPrefix": "health" }, "aws.auth#sigv4": { "name": "health" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Health\n

The Health API provides access to the Health information that appears in the\n Health Dashboard. You can use\n the API operations to get information about events that might affect your Amazon Web Services services and resources.

\n

You must have an Amazon Web Services Business Support+, Amazon Web Services Enterprise Support, or Amazon Web Services Unified Operations plan from Amazon Web Services Support to use the Health API. If you're in an Amazon Web Services Region that doesn't offer one of these Amazon Web Services Support plans, or if you haven't transitioned to one of these plans, you can use the Health API with a Business, Enterprise On-Ramp, or Enterprise Support plan. If you call the Health API from an\n Amazon Web Services account that isn't enrolled in one of these plans, then you receive a\n SubscriptionRequiredException error.

\n

For API access, you need an access key ID and a secret access key. Use temporary\n credentials instead of long-term access keys when possible. Temporary credentials include\n an access key ID, a secret access key, and a security token that indicates when the\n credentials expire. For more information, see Best practices for managing\n Amazon Web Services access keys in the Amazon Web Services General Reference.

\n

You can use the Health endpoint health.us-east-1.amazonaws.com (HTTPS) to call the\n Health API operations. Health supports a multi-Region application architecture\n and has two regional endpoints in an active-passive configuration. You can use the high\n availability endpoint example to determine which Amazon Web Services Region is active, so that you can\n get the latest information from the API. For more information, see Accessing the Health\n API in the Health User Guide.

\n

For authentication of requests, Health uses the Signature Version 4 Signing\n Process.

\n

If your Amazon Web Services account is part of Organizations, you can use the Health organizational\n view feature. This feature provides a centralized view of Health events across all\n accounts in your organization. You can aggregate Health events in real time to\n identify accounts in your organization that are affected by an operational event or get\n notified of security vulnerabilities. Use the organizational view API operations to enable\n this feature and return event information. For more information, see Aggregating\n Health events in the Health User Guide.

\n \n

When you use the Health API operations to return Health events, see the\n following recommendations:

\n \n
", "smithy.api#title": "AWS Health APIs and Notifications", "smithy.protocols#rpcv2Cbor": {}, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-global" ] }, { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-cn-global" ] } ], "results": [ { "conditions": [], "endpoint": { "url": "https://health-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://health-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://global.health.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://global.health.amazonaws.com.cn", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "cn-northwest-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 24, "nodes": "/////wAAAAH/////AAAAAAAAABYAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAABIAAAAGAAAABAAAAA4AAAAHAAAABQAAAA4AAAAIAAAABgAAAA4AAAAJAAAABwAAAA4AAAAKAAAACAAAAA4AAAALAAAACgAAAA4AAAAMAAAACwAAAA4AAAANAAAADAX14QEF9eECAAAADAAAABEAAAAPAAAADgX14QoAAAAQAAAADwX14QsF9eEMAAAADQX14QcF9eEIAAAACQAAABQAAAATAAAADAX14QYF9eEJAAAADAAAABUF9eECAAAADQX14QEF9eEGAAAAAwAAABgAAAAXAAAADAX14QMF9eEFAAAADAX14QMF9eEE" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "not", "argv": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-b" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-e" ] } ] }, { "fn": "not", "argv": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-iso-f" ] } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "endpoint": { "url": "https://health-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://health-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://health-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://health.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-global" ] } ], "endpoint": { "url": "https://global.health.amazonaws.com", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "us-east-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "ref": "Region" }, "aws-cn-global" ] } ], "endpoint": { "url": "https://global.health.amazonaws.com.cn", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "cn-northwest-1" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://health.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region aws-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "us-east-1" } ] }, "url": "https://global.health.amazonaws.com" } }, "params": { "Region": "aws-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "cn-northwest-1" } ] }, "url": "https://global.health.amazonaws.com.cn" } }, "params": { "Region": "aws-cn-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region aws-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "us-east-1" } ] }, "url": "https://global.health.amazonaws.com" } }, "params": { "Region": "aws-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region aws-cn-global with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "health", "signingRegion": "cn-northwest-1" } ] }, "url": "https://global.health.amazonaws.com.cn" } }, "params": { "Region": "aws-cn-global", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-iso-east-1.api.aws.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-isob-east-1.api.aws.scloud" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-isob-east-1.api.aws.scloud" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.us-isof-south-1.api.aws.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.us-isof-south-1.api.aws.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.eu-isoe-west-1.api.cloud-aws.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.eu-isoe-west-1.api.cloud-aws.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health.eusc-de-east-1.api.amazonwebservices.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health.eusc-de-east-1.api.amazonwebservices.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://health-fips.eusc-de-east-1.api.amazonwebservices.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://health-fips.eusc-de-east-1.api.amazonwebservices.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } } ], "version": "1.0" } } }, "com.amazonaws.health#AccountEntity": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } }, "accountTags": { "target": "com.amazonaws.health#AccountTagSet", "traits": { "smithy.api#documentation": "

A map of tag key-value pairs attached to the affected account.

" } } }, "traits": { "smithy.api#documentation": "

An entity representing an affected account, including its account ID and associated tags.

" } }, "com.amazonaws.health#AccountEntityAggregate": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

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

" } }, "count": { "target": "com.amazonaws.health#count", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of entities that match the filter criteria for the specified events.

" } }, "statuses": { "target": "com.amazonaws.health#entityStatuses", "traits": { "smithy.api#documentation": "

The number of affected entities aggregated by the entity status codes.

" } } }, "traits": { "smithy.api#documentation": "

The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.

" } }, "com.amazonaws.health#AccountEntityAggregatesList": { "type": "list", "member": { "target": "com.amazonaws.health#AccountEntityAggregate" } }, "com.amazonaws.health#AccountTag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#tagKey", "traits": { "smithy.api#documentation": "

The tag key.

" } }, "value": { "target": "com.amazonaws.health#tagValue", "traits": { "smithy.api#documentation": "

The tag value.

" } }, "type": { "target": "com.amazonaws.health#AccountTagType", "traits": { "smithy.api#documentation": "

The type of tag (resource tag or account tag).

" } } }, "traits": { "smithy.api#documentation": "

A tag key-value pair associated with a resource in an account.

" } }, "com.amazonaws.health#AccountTagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{1,127}$" } }, "com.amazonaws.health#AccountTagList": { "type": "list", "member": { "target": "com.amazonaws.health#AccountTag" } }, "com.amazonaws.health#AccountTagSet": { "type": "map", "key": { "target": "com.amazonaws.health#AccountTagKey" }, "value": { "target": "com.amazonaws.health#AccountTagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#AccountTagType": { "type": "enum", "members": { "ACCOUNT_RESOURCE_TAG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_RESOURCE_TAG" } } } }, "com.amazonaws.health#AccountTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{0,255}$" } }, "com.amazonaws.health#AffectedAccountEntityList": { "type": "list", "member": { "target": "com.amazonaws.health#AccountEntity" } }, "com.amazonaws.health#AffectedAccountFilter": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "tags": { "target": "com.amazonaws.health#AffectedAccountsForOrganizationTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.

\n

An account is returned when its own tags, or the tags of one of its affected resources, match.

" } } }, "traits": { "smithy.api#documentation": "

A filter for narrowing down affected accounts in an organization event.

" } }, "com.amazonaws.health#AffectedAccountsForOrganizationTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#AffectedAccountsForOrganizationTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#AffectedAccountsForOrganizationTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#AffectedEntitiesForOrganizationTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#AffectedEntitiesForOrganizationTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#AffectedEntitiesForOrganizationTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#AffectedEntity": { "type": "structure", "members": { "entityArn": { "target": "com.amazonaws.health#entityArn", "traits": { "smithy.api#documentation": "

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

" } }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "entityValue": { "target": "com.amazonaws.health#entityValue", "traits": { "smithy.api#documentation": "

The ID of the affected entity.

" } }, "entityUrl": { "target": "com.amazonaws.health#entityUrl", "traits": { "smithy.api#documentation": "

The URL of the affected entity.

" } }, "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } }, "lastUpdatedTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The most recent time that the entity was updated.

" } }, "statusCode": { "target": "com.amazonaws.health#entityStatusCode", "traits": { "smithy.api#documentation": "

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

" } }, "resourceTags": { "target": "com.amazonaws.health#ResourceTagSet", "traits": { "smithy.api#documentation": "

A map of resource tag key-value pairs attached to the affected entity.

" } }, "accountTags": { "target": "com.amazonaws.health#AccountTagSet", "traits": { "smithy.api#documentation": "

A map of account tag key-value pairs for the account that owns the affected entity. This field is returned only by DescribeAffectedEntitiesForOrganization and is not populated by DescribeAffectedEntities.

" } }, "entityMetadata": { "target": "com.amazonaws.health#entityMetadata", "traits": { "smithy.api#documentation": "

Additional metadata about the affected entity.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.health#Boolean": { "type": "boolean", "traits": { "smithy.api#default": false } }, "com.amazonaws.health#ConcurrentModificationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.health#string" } }, "traits": { "smithy.api#documentation": "

\n EnableHealthServiceAccessForOrganization is already in progress. Wait for the\n action to complete before trying again. To get the current status, use the DescribeHealthServiceStatusForOrganization operation.

", "smithy.api#error": "client" } }, "com.amazonaws.health#ConfigureTags": { "type": "operation", "input": { "target": "com.amazonaws.health#ConfigureTagsRequest" }, "output": { "target": "com.amazonaws.health#ConfigureTagsResponse" }, "traits": { "smithy.api#documentation": "

Configures which resource tag keys are tracked by Health for your account. This operation replaces the existing configuration with the specified tag keys. Only configured tag keys will appear in Health event data.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#ConfigureTagsForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#ConfigureTagsForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#ConfigureTagsForOrganizationResponse" }, "traits": { "smithy.api#documentation": "

Configures which tag keys are tracked by Health for all accounts in your organization. This operation replaces the existing configuration with the specified tag keys. Only configured tag keys will appear in Health event data across the organization.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#ConfigureTagsForOrganizationRequest": { "type": "structure", "members": { "tagKeys": { "target": "com.amazonaws.health#ConfigureTagsForOrganizationTagKeyList", "traits": { "smithy.api#documentation": "

The list of tag keys to configure for Health event tracking across the organization.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#ConfigureTagsForOrganizationResponse": { "type": "structure", "members": { "configuredTagKeys": { "target": "com.amazonaws.health#ConfigureTagsForOrganizationResponseTagKeyList", "traits": { "smithy.api#documentation": "

The list of tag keys that were successfully configured for the organization, with the current status of each tag key.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#ConfigureTagsForOrganizationResponseTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationTagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#ConfigureTagsForOrganizationTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#TagKeyForOrganization" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#ConfigureTagsRequest": { "type": "structure", "members": { "tagKeys": { "target": "com.amazonaws.health#ConfigureTagsRequestTagKeyList", "traits": { "smithy.api#documentation": "

The list of resource tag keys to configure for Health event tracking.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#ConfigureTagsRequestTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#ConfigureTagsTagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#ConfigureTagsResourceTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#ResourceTagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#ConfigureTagsResponse": { "type": "structure", "members": { "configuredTagKeys": { "target": "com.amazonaws.health#ConfigureTagsResourceTagKeyList", "traits": { "smithy.api#documentation": "

The list of resource tag keys that were successfully configured.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#ConfigureTagsTagKey": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#ResourceTagKey2", "traits": { "smithy.api#documentation": "

The tag key name.

", "smithy.api#required": {} } }, "enabledForEventBridge": { "target": "com.amazonaws.health#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Whether this tag key is enabled for EventBridge notifications.

" } } }, "traits": { "smithy.api#documentation": "

A resource tag key to configure for Health event tracking.

" } }, "com.amazonaws.health#DateTimeRange": { "type": "structure", "members": { "from": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The starting date and time of a time range.

" } }, "to": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The ending date and time of a time range.

" } } }, "traits": { "smithy.api#documentation": "

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set:\n match items where the timestamp (startTime, endTime, or\n lastUpdatedTime) is between from and to\n inclusive. If from is set and to is not set: match items where\n the timestamp value is equal to or after from. If from is not set\n and to is set: match items where the timestamp value is equal to or before\n to.

" } }, "com.amazonaws.health#DescribeAffectedAccountsForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeAffectedAccountsForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeAffectedAccountsForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" } ], "traits": { "smithy.api#documentation": "

Returns a list of accounts in the organization from Organizations that are affected by the\n provided event. For more information about the different types of Health events, see\n Event.

\n

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

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "affectedAccounts", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeAffectedAccountsForOrganizationRequest": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } }, "filter": { "target": "com.amazonaws.health#AffectedAccountFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeAffectedAccountsForOrganizationResponse": { "type": "structure", "members": { "affectedAccounts": { "target": "com.amazonaws.health#affectedAccountsList", "traits": { "smithy.api#documentation": "

A JSON set of elements of the affected accounts.

" } }, "affectedAccountEntities": { "target": "com.amazonaws.health#AffectedAccountEntityList", "traits": { "smithy.api#documentation": "

The list of affected account entities, including account IDs and their associated tags.

" } }, "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeAffectedEntities": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeAffectedEntitiesRequest" }, "output": { "target": "com.amazonaws.health#DescribeAffectedEntitiesResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" }, { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns a list of entities that have been affected by the specified events, based on the\n specified filter criteria. Entities can refer to individual customer resources, groups of\n customer resources, or any other construct, depending on the Amazon Web Services service. Events that\n have impact beyond that of the affected entities, or where the extent of impact is unknown,\n include at least one entity indicating this.

\n

At least one event ARN is required.

\n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "entities", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" }, { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

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

\n

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

\n

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

\n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "entities", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationFailedSet": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationAffectedEntitiesErrorItem" } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationRequest": { "type": "structure", "members": { "organizationEntityFilters": { "target": "com.amazonaws.health#OrganizationEntityFiltersList", "traits": { "smithy.api#deprecated": { "message": "This property is deprecated, use organizationEntityAccountFilters instead." }, "smithy.api#documentation": "

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

" } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 1 and 100, inclusive.

" } }, "organizationEntityAccountFilters": { "target": "com.amazonaws.health#OrganizationEntityAccountFiltersList", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationResponse": { "type": "structure", "members": { "entities": { "target": "com.amazonaws.health#EntityList", "traits": { "smithy.api#documentation": "

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

" } }, "failedSet": { "target": "com.amazonaws.health#DescribeAffectedEntitiesForOrganizationFailedSet", "traits": { "smithy.api#documentation": "

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

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeAffectedEntitiesRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#EntityFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned. At least one event ARN is required.

", "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 1 and 100, inclusive.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeAffectedEntitiesResponse": { "type": "structure", "members": { "entities": { "target": "com.amazonaws.health#EntityList", "traits": { "smithy.api#documentation": "

The entities that match the filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeAffectedEntitiesTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#DescribeAffectedEntitiesTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#DescribeAffectedEntitiesTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#DescribeEntityAggregates": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEntityAggregatesRequest" }, "output": { "target": "com.amazonaws.health#DescribeEntityAggregatesResponse" }, "traits": { "smithy.api#documentation": "

Returns the number of entities that are affected by each of the specified events.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeEntityAggregatesForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEntityAggregatesForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeEntityAggregatesForOrganizationResponse" }, "traits": { "smithy.api#documentation": "

Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeEntityAggregatesForOrganizationRequest": { "type": "structure", "members": { "eventArns": { "target": "com.amazonaws.health#OrganizationEventArnsList", "traits": { "smithy.api#documentation": "

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\"\n

", "smithy.api#required": {} } }, "awsAccountIds": { "target": "com.amazonaws.health#OrganizationAccountIdsList", "traits": { "smithy.api#documentation": "

A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

" } }, "filter": { "target": "com.amazonaws.health#OrganizationEntityAggregateFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEntityAggregatesForOrganizationResponse": { "type": "structure", "members": { "organizationEntityAggregates": { "target": "com.amazonaws.health#OrganizationEntityAggregatesList", "traits": { "smithy.api#documentation": "

The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEntityAggregatesRequest": { "type": "structure", "members": { "eventArns": { "target": "com.amazonaws.health#EventArnsList", "traits": { "smithy.api#documentation": "

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\"\n

" } }, "filter": { "target": "com.amazonaws.health#EntityAggregateFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEntityAggregatesResponse": { "type": "structure", "members": { "entityAggregates": { "target": "com.amazonaws.health#EntityAggregateList", "traits": { "smithy.api#documentation": "

The number of entities that are affected by each of the specified events.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEntityAggregatesTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#DescribeEntityAggregatesTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#DescribeEntityAggregatesTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#DescribeEventAggregates": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventAggregatesRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventAggregatesResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" } ], "traits": { "smithy.api#documentation": "

Returns the number of events of each event type (issue, scheduled change, and account\n notification). If no filter is specified, the counts of all events in each category are\n returned.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "eventAggregates", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeEventAggregatesRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#EventFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "aggregateField": { "target": "com.amazonaws.health#eventAggregateField", "traits": { "smithy.api#documentation": "

The only currently supported value is eventTypeCategory.

", "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.health#maxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventAggregatesResponse": { "type": "structure", "members": { "eventAggregates": { "target": "com.amazonaws.health#EventAggregateList", "traits": { "smithy.api#documentation": "

The number of events in each category that meet the optional filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEventDetails": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventDetailsRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventDetailsResponse" }, "errors": [ { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns detailed information about one or more specified events. Information includes\n standard event data (Amazon Web Services Region, service, and so on, as returned by DescribeEvents), a detailed event description, and possible additional metadata\n that depends upon the nature of the event. Affected entities are not included. To retrieve\n the entities, use the DescribeAffectedEntities operation.

\n

If a specified event can't be retrieved, an error message is returned for that\n event.

\n \n

This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more\n information, see Resource- and action-based conditions in the Health User Guide.

\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeEventDetailsFailedSet": { "type": "list", "member": { "target": "com.amazonaws.health#EventDetailsErrorItem" } }, "com.amazonaws.health#DescribeEventDetailsForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventDetailsForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventDetailsForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns detailed information about one or more specified events for one or more\n Amazon Web Services accounts in your organization. This information includes standard event data (such as\n the Amazon Web Services Region and service), an event description, and (depending on the event) possible\n metadata. This operation doesn't return affected entities, such as the resources related to\n the event. To return affected entities, use the DescribeAffectedEntitiesForOrganization operation.

\n \n

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

\n
\n

When you call the DescribeEventDetailsForOrganization operation, specify\n the organizationEventDetailFilters object in the request. Depending on the\n Health event type, note the following differences:

\n \n

For more information, see Event.

\n \n

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\n information, see Resource- and action-based conditions in the Health User Guide.

\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeEventDetailsForOrganizationFailedSet": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationEventDetailsErrorItem" } }, "com.amazonaws.health#DescribeEventDetailsForOrganizationRequest": { "type": "structure", "members": { "organizationEventDetailFilters": { "target": "com.amazonaws.health#OrganizationEventDetailFiltersList", "traits": { "smithy.api#documentation": "

A set of JSON elements that includes the awsAccountId and the\n eventArn.

", "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventDetailsForOrganizationResponse": { "type": "structure", "members": { "successfulSet": { "target": "com.amazonaws.health#DescribeEventDetailsForOrganizationSuccessfulSet", "traits": { "smithy.api#documentation": "

Information about the events that could be retrieved.

" } }, "failedSet": { "target": "com.amazonaws.health#DescribeEventDetailsForOrganizationFailedSet", "traits": { "smithy.api#documentation": "

Error messages for any events that could not be retrieved.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEventDetailsForOrganizationSuccessfulSet": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationEventDetails" } }, "com.amazonaws.health#DescribeEventDetailsRequest": { "type": "structure", "members": { "eventArns": { "target": "com.amazonaws.health#eventArnList", "traits": { "smithy.api#documentation": "

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\"\n

", "smithy.api#required": {} } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventDetailsResponse": { "type": "structure", "members": { "successfulSet": { "target": "com.amazonaws.health#DescribeEventDetailsSuccessfulSet", "traits": { "smithy.api#documentation": "

Information about the events that could be retrieved.

" } }, "failedSet": { "target": "com.amazonaws.health#DescribeEventDetailsFailedSet", "traits": { "smithy.api#documentation": "

Error messages for any events that could not be retrieved.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEventDetailsSuccessfulSet": { "type": "list", "member": { "target": "com.amazonaws.health#EventDetails" } }, "com.amazonaws.health#DescribeEventTypes": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventTypesRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventTypesResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" }, { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns the event types that meet the specified filter criteria. You can use this API\n operation to find information about the Health event, such as the category, Amazon Web Services service, and event code. The metadata for each event appears in the EventType object.

\n

If you don't specify a filter criteria, the API operation returns all event types, in no\n particular order.

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "eventTypes", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeEventTypesRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#EventTypeFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

\n \n

If you don't specify the maxResults parameter, this operation returns a\n maximum of 30 items by default.

\n
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventTypesResponse": { "type": "structure", "members": { "eventTypes": { "target": "com.amazonaws.health#EventTypeList", "traits": { "smithy.api#documentation": "

A list of event types that match the filter criteria. Event types have a category\n (issue, accountNotification, or scheduledChange),\n a service (for example, EC2, RDS, DATAPIPELINE,\n BILLING), and a code (in the format\n AWS_SERVICE_DESCRIPTION\n ; for\n example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEvents": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventsRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventsResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" }, { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns information about events that meet the specified filter criteria. Events are\n returned in a summary form and do not include the detailed description, any additional\n metadata that depends on the event type, or any affected resources. To retrieve that\n information, use the DescribeEventDetails and DescribeAffectedEntities operations.

\n

If no filter criteria are specified, all events are returned. Results are sorted by\n lastModifiedTime, starting with the most recent event.

\n \n \n ", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "events", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeEventsForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeEventsForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeEventsForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" }, { "target": "com.amazonaws.health#UnsupportedLocale" } ], "traits": { "smithy.api#documentation": "

Returns information about events across your organization in Organizations. You can use\n thefilters parameter to specify the events that you want to return. Events\n are returned in a summary form and don't include the affected accounts, detailed\n description, any additional metadata that depends on the event type, or any affected\n resources. To retrieve that information, use the following operations:

\n \n

If you don't specify a filter, the\n DescribeEventsForOrganizations returns all events across your organization.\n Results are sorted by lastModifiedTime, starting with the most recent event.

\n

For more information about the different types of Health events, see Event.

\n

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

\n \n

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

\n
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "events", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeEventsForOrganizationRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#OrganizationEventFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 1 and 100, inclusive.

" } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventsForOrganizationResponse": { "type": "structure", "members": { "events": { "target": "com.amazonaws.health#OrganizationEventList", "traits": { "smithy.api#documentation": "

The events that match the specified filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEventsRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#EventFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 1 and 100, inclusive.

" } }, "locale": { "target": "com.amazonaws.health#locale", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeEventsResponse": { "type": "structure", "members": { "events": { "target": "com.amazonaws.health#EventList", "traits": { "smithy.api#documentation": "

The events that match the specified filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeEventsTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#DescribeEventsTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#DescribeEventsTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#DescribeHealthServiceStatusForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.health#DescribeHealthServiceStatusForOrganizationResponse" }, "traits": { "smithy.api#documentation": "

This operation provides status information on enabling or disabling Health to work\n with your organization. To call this operation, you must use the organization's\n management account.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeHealthServiceStatusForOrganizationResponse": { "type": "structure", "members": { "healthServiceAccessStatusForOrganization": { "target": "com.amazonaws.health#healthServiceAccessStatusForOrganization", "traits": { "smithy.api#documentation": "

Information about the status of enabling or disabling the Health organizational\n view feature in your organization.

\n

Valid values are ENABLED | DISABLED | PENDING.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeServiceLifecycle": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeServiceLifecycleRequest" }, "output": { "target": "com.amazonaws.health#DescribeServiceLifecycleResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" } ], "traits": { "smithy.api#documentation": "

Returns lifecycle information for Amazon Web Services services, including end-of-life dates, version recommendations, and lifecycle events.

", "smithy.api#examples": [ { "title": "To retrieve service lifecycle information", "documentation": "The following example returns service lifecycle information, including support milestones and lifecycle events for each service version.", "input": { "maxResults": 5 }, "output": { "serviceLifecycles": [ { "service": "BEDROCK", "version": "ai21.jamba-1-5-large-v1:0", "title": "AI21 Labs Jamba 1.5 Large", "lifecycleEvents": [ { "lifecycleEventType": "STANDARD_SUPPORT_END", "date": "2026-05-26T00:00:00Z", "regions": [ "all" ], "impactRisks": [ "END_OF_SUPPORT" ], "description": "Model enters Legacy state \u2014 no longer actively maintained. Public extended access (pricing may increase) starts 2026-08-26" }, { "lifecycleEventType": "EXTENDED_SUPPORT_END", "date": "2026-11-26T00:00:00Z", "regions": [ "all" ], "impactRisks": [ "AVAILABILITY" ], "description": "Model is no longer available for inference" } ] }, { "service": "BEDROCK", "version": "amazon.nova-2-lite-v1:0", "title": "Amazon Nova 2 Lite", "lifecycleEvents": [ { "lifecycleEventType": "SUPPORTED", "date": "2025-12-02T00:00:00Z", "regions": [ "all" ], "impactRisks": [], "description": "Amazon Nova 2 Lite available on Amazon Bedrock" } ] } ], "nextToken": "AQICAHjDhCYeYPq-zXMzcdNOIWJQKCUN1s1J84fdK4ztGn9uoAExampleTokenExampleTokenExampleToken" } } ], "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "serviceLifecycles", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeServiceLifecycleRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#ServiceLifecycleFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#LifecycleMaxResults", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeServiceLifecycleResponse": { "type": "structure", "members": { "serviceLifecycles": { "target": "com.amazonaws.health#ServiceLifecycleList", "traits": { "smithy.api#documentation": "

The list of service lifecycle entries matching the filter criteria.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTagKeys": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.health#DescribeTagKeysResponse" }, "traits": { "smithy.api#documentation": "

Returns the list of resource tag keys configured for Health event tracking in your account.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeTagKeysForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.health#DescribeTagKeysForOrganizationResponse" }, "traits": { "smithy.api#documentation": "

Returns the list of tag keys configured for Health event tracking across your organization.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeTagKeysForOrganizationResponse": { "type": "structure", "members": { "keys": { "target": "com.amazonaws.health#OrganizationTagKeyList", "traits": { "smithy.api#documentation": "

The list of configured tag keys for the organization and their status.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTagKeysResponse": { "type": "structure", "members": { "keys": { "target": "com.amazonaws.health#ResourceTagKeyList", "traits": { "smithy.api#documentation": "

The list of configured resource tag keys and their status.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTags": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeTagsRequest" }, "output": { "target": "com.amazonaws.health#DescribeTagsResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" } ], "traits": { "smithy.api#documentation": "

Returns the resource tags associated with Health events for your account. Use this operation to retrieve the actual tag key-value pairs attached to affected entities.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tags", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeTagsForOrganization": { "type": "operation", "input": { "target": "com.amazonaws.health#DescribeTagsForOrganizationRequest" }, "output": { "target": "com.amazonaws.health#DescribeTagsForOrganizationResponse" }, "errors": [ { "target": "com.amazonaws.health#InvalidPaginationToken" } ], "traits": { "smithy.api#documentation": "

Returns the tags associated with Health events across all accounts in your organization.

", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "items": "tags", "pageSize": "maxResults" } } }, "com.amazonaws.health#DescribeTagsForOrganizationFilter": { "type": "structure", "members": { "tagTypes": { "target": "com.amazonaws.health#OrganizationTagTypeFilter", "traits": { "smithy.api#documentation": "

The types of tags to include in the results.

" } } }, "traits": { "smithy.api#documentation": "

A filter for narrowing down the tags returned by DescribeTagsForOrganization.

" } }, "com.amazonaws.health#DescribeTagsForOrganizationRequest": { "type": "structure", "members": { "filter": { "target": "com.amazonaws.health#DescribeTagsForOrganizationFilter", "traits": { "smithy.api#documentation": "

Values to narrow the results returned.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeTagsForOrganizationResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.health#OrganizationTagList", "traits": { "smithy.api#documentation": "

The list of tags associated with Health events across the organization.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTagsOnboardingStatus": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.health#DescribeTagsOnboardingStatusResponse" }, "traits": { "smithy.api#documentation": "

Returns the current onboarding status of the Health tags feature for your account.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeTagsOnboardingStatusForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.health#DescribeTagsOnboardingStatusForOrganizationResponse" }, "traits": { "smithy.api#documentation": "

Returns the current onboarding status of the Health tags feature for your organization.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DescribeTagsOnboardingStatusForOrganizationResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.health#TagsOnboardingStatusForOrganization", "traits": { "smithy.api#documentation": "

The current onboarding status of the tags feature for the organization.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTagsOnboardingStatusResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.health#TagsOnboardingStatus", "traits": { "smithy.api#documentation": "

The current onboarding status of the tags feature for the account.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DescribeTagsRequest": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } }, "maxResults": { "target": "com.amazonaws.health#maxResultsLowerRange", "traits": { "smithy.api#documentation": "

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.health#DescribeTagsResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.health#AccountTagList", "traits": { "smithy.api#documentation": "

The list of resource tags associated with Health events.

" } }, "nextToken": { "target": "com.amazonaws.health#nextToken", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.health#DisableHealthServiceAccessForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.health#ConcurrentModificationException" } ], "traits": { "smithy.api#documentation": "

Disables Health from working with Organizations. To call this operation, you must sign\n in to the organization's management account. For more information, see Aggregating\n Health events in the Health User Guide.

\n

This operation doesn't remove the service-linked role from the management account in your\n organization. You must use the IAM console, API, or Command Line Interface (CLI) to remove the\n service-linked role. For more information, see Deleting a Service-Linked Role in the\n IAM User Guide.

\n \n

You can also disable the organizational feature by using the Organizations DisableAWSServiceAccess API operation. After you call this operation,\n Health stops aggregating events for all other Amazon Web Services accounts in your organization.\n If you call the Health API operations for organizational view, Health returns\n an error. Health continues to aggregate health events for your\n Amazon Web Services account.

\n
", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DisableTags": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "

Disables the Health tags feature for your account. After disabling, Health events will no longer include resource tag information. Previously configured tag keys are discarded.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#DisableTagsForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "

Disables the Health tags feature for all accounts in your organization.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#EnableHealthServiceAccessForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.health#ConcurrentModificationException" } ], "traits": { "smithy.api#documentation": "

Enables Health to work with Organizations. You can use the organizational view feature\n to aggregate events from all Amazon Web Services accounts in your organization in a centralized location.

\n

This operation also creates a service-linked role for the management account in the\n organization.

\n \n

To call this operation, you must meet the following requirements:

\n \n
\n

If you don't have the required support plan, you can instead use the Health console\n to enable the organizational view feature. For more information, see Aggregating\n Health events in the Health User Guide.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#EnableTags": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "

Enables the Health tags feature for your account. Once enabled, Health events will include resource tag information for affected entities. If the feature is already enabled, this operation has no effect.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#EnableTagsForOrganization": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "smithy.api#Unit" }, "traits": { "smithy.api#documentation": "

Enables the Health tags feature for all accounts in your organization. Once enabled, Health events will include resource tag information for affected entities across your organization.

", "smithy.api#idempotent": {} } }, "com.amazonaws.health#EntityAccountFilter": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

", "smithy.api#required": {} } }, "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } }, "statusCodes": { "target": "com.amazonaws.health#entityStatusCodeList", "traits": { "smithy.api#documentation": "

A list of entity status codes.

" } }, "tags": { "target": "com.amazonaws.health#AffectedEntitiesForOrganizationTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.

\n

An entity is returned when the tags of the resource, or of the account it belongs to, match. When you specify several filters in organizationEntityAccountFilters, the tags must be identical in every filter.

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.health#EntityAggregate": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "count": { "target": "com.amazonaws.health#count", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of entities that match the criteria for the specified events.

" } }, "statuses": { "target": "com.amazonaws.health#entityStatuses", "traits": { "smithy.api#documentation": "

The number of affected entities aggregated by the entity status codes.

" } } }, "traits": { "smithy.api#documentation": "

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

" } }, "com.amazonaws.health#EntityAggregateFilter": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.health#DescribeEntityAggregatesTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.

\n

Only entities whose tags match are included in the aggregates.

" } } }, "traits": { "smithy.api#documentation": "

A filter for narrowing down the entity aggregates returned by DescribeEntityAggregates.

" } }, "com.amazonaws.health#EntityAggregateList": { "type": "list", "member": { "target": "com.amazonaws.health#EntityAggregate" } }, "com.amazonaws.health#EntityFilter": { "type": "structure", "members": { "eventArns": { "target": "com.amazonaws.health#eventArnList", "traits": { "smithy.api#documentation": "

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\"\n

", "smithy.api#required": {} } }, "entityArns": { "target": "com.amazonaws.health#entityArnList", "traits": { "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" } }, "entityValues": { "target": "com.amazonaws.health#entityValueList", "traits": { "smithy.api#documentation": "

A list of IDs for affected entities.

" } }, "lastUpdatedTimes": { "target": "com.amazonaws.health#dateTimeRangeList", "traits": { "smithy.api#documentation": "

A list of the most recent dates and times that the entity was updated.

" } }, "tags": { "target": "com.amazonaws.health#DescribeAffectedEntitiesTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. The filter matches when at least one key in the map matches.

" } }, "statusCodes": { "target": "com.amazonaws.health#entityStatusCodeList", "traits": { "smithy.api#documentation": "

A list of entity status codes (IMPAIRED, UNIMPAIRED, or\n UNKNOWN).

" } } }, "traits": { "smithy.api#documentation": "

The values to use to filter results from the DescribeAffectedEntities operation.

" } }, "com.amazonaws.health#EntityList": { "type": "list", "member": { "target": "com.amazonaws.health#AffectedEntity" } }, "com.amazonaws.health#Event": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

" } }, "eventTypeCode": { "target": "com.amazonaws.health#eventTypeCode", "traits": { "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } }, "eventTypeCategory": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "region": { "target": "com.amazonaws.health#region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region name of the event.

" } }, "availabilityZone": { "target": "com.amazonaws.health#availabilityZone", "traits": { "smithy.api#documentation": "

The Amazon Web Services Availability Zone of the event. For example, us-east-1a.

" } }, "startTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The date and time that the event began.

" } }, "endTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The date and time that the event ended.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The most recent date and time that the event was updated.

" } }, "statusCode": { "target": "com.amazonaws.health#eventStatusCode", "traits": { "smithy.api#documentation": "

The most recent status of the event. Possible values are open,\n closed, and upcoming.

" } }, "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } }, "actionability": { "target": "com.amazonaws.health#EventActionability", "traits": { "smithy.api#documentation": "

The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required.\nEvents with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

" } }, "personas": { "target": "com.amazonaws.health#EventPersonaList", "traits": { "smithy.api#documentation": "

A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about an Health event.

\n

Health events can be public or account-specific:

\n \n

You can determine if an event is public or account-specific by using the\n eventScopeCode parameter. For more information, see eventScopeCode.

" } }, "com.amazonaws.health#EventAccountFilter": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

", "smithy.api#required": {} } }, "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.health#EventActionability": { "type": "enum", "members": { "ACTION_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_REQUIRED" } }, "ACTION_MAY_BE_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_MAY_BE_REQUIRED" } }, "INFORMATIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFORMATIONAL" } } } }, "com.amazonaws.health#EventActionabilityList": { "type": "list", "member": { "target": "com.amazonaws.health#EventActionability" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.health#EventAggregate": { "type": "structure", "members": { "aggregateValue": { "target": "com.amazonaws.health#aggregateValue", "traits": { "smithy.api#documentation": "

The issue type for the associated count.

" } }, "count": { "target": "com.amazonaws.health#count", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of events of the associated issue type.

" } } }, "traits": { "smithy.api#documentation": "

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

" } }, "com.amazonaws.health#EventAggregateList": { "type": "list", "member": { "target": "com.amazonaws.health#EventAggregate" } }, "com.amazonaws.health#EventArnsList": { "type": "list", "member": { "target": "com.amazonaws.health#eventArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#EventDescription": { "type": "structure", "members": { "latestDescription": { "target": "com.amazonaws.health#EventDescription2", "traits": { "smithy.api#documentation": "

The most recent description of the event.

" } } }, "traits": { "smithy.api#documentation": "

The detailed description of the event. Included in the information returned by the\n DescribeEventDetails operation.

" } }, "com.amazonaws.health#EventDescription2": { "type": "string" }, "com.amazonaws.health#EventDetails": { "type": "structure", "members": { "event": { "target": "com.amazonaws.health#Event", "traits": { "smithy.api#documentation": "

Summary information about the event.

" } }, "eventDescription": { "target": "com.amazonaws.health#EventDescription", "traits": { "smithy.api#documentation": "

The most recent description of the event.

" } }, "eventMetadata": { "target": "com.amazonaws.health#eventMetadata", "traits": { "smithy.api#documentation": "

Additional metadata about the event.

" } } }, "traits": { "smithy.api#documentation": "

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by\n the DescribeEventDetails operation.

" } }, "com.amazonaws.health#EventDetailsErrorItem": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "errorName": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The name of the error.

" } }, "errorMessage": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

A message that describes the error.

" } } }, "traits": { "smithy.api#documentation": "

Error information returned when a DescribeEventDetails operation can't find a specified event.

" } }, "com.amazonaws.health#EventFilter": { "type": "structure", "members": { "actionabilities": { "target": "com.amazonaws.health#EventActionabilityList", "traits": { "smithy.api#documentation": "

A list of actionability values to filter events. Use this to filter events based on whether they require action (ACTION_REQUIRED), may require action (ACTION_MAY_BE_REQUIRED) or are informational (INFORMATIONAL).

" } }, "eventArns": { "target": "com.amazonaws.health#eventArnList", "traits": { "smithy.api#documentation": "

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\"\n

" } }, "eventTypeCodes": { "target": "com.amazonaws.health#eventTypeList2", "traits": { "smithy.api#documentation": "

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".\n

" } }, "services": { "target": "com.amazonaws.health#serviceList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "regions": { "target": "com.amazonaws.health#regionList", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services Regions.

" } }, "availabilityZones": { "target": "com.amazonaws.health#availabilityZones", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services Availability Zones.

" } }, "startTimes": { "target": "com.amazonaws.health#dateTimeRangeList", "traits": { "smithy.api#documentation": "

A list of dates and times that the event began.

" } }, "endTimes": { "target": "com.amazonaws.health#dateTimeRangeList", "traits": { "smithy.api#documentation": "

A list of dates and times that the event ended.

" } }, "lastUpdatedTimes": { "target": "com.amazonaws.health#dateTimeRangeList", "traits": { "smithy.api#documentation": "

A list of dates and times that the event was last updated.

" } }, "entityArns": { "target": "com.amazonaws.health#entityArnList", "traits": { "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" } }, "entityValues": { "target": "com.amazonaws.health#entityValueList", "traits": { "smithy.api#documentation": "

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS\n volumes (vol-426ab23e).

" } }, "eventTypeCategories": { "target": "com.amazonaws.health#eventTypeCategoryList2", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "tags": { "target": "com.amazonaws.health#DescribeEventsTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. The filter matches when at least one key in the map matches.

" } }, "eventStatusCodes": { "target": "com.amazonaws.health#eventStatusCodeList", "traits": { "smithy.api#documentation": "

A list of event status codes.

" } }, "personas": { "target": "com.amazonaws.health#EventPersonaList", "traits": { "smithy.api#documentation": "

A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.

" } } }, "traits": { "smithy.api#documentation": "

The values to use to filter results from the DescribeEvents and\n DescribeEventAggregates operations.

" } }, "com.amazonaws.health#EventList": { "type": "list", "member": { "target": "com.amazonaws.health#Event" } }, "com.amazonaws.health#EventPersona": { "type": "enum", "members": { "OPERATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPERATIONS" } }, "SECURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITY" } }, "BILLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING" } } } }, "com.amazonaws.health#EventPersonaList": { "type": "list", "member": { "target": "com.amazonaws.health#EventPersona" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.health#EventType": { "type": "structure", "members": { "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event. For example, EC2, RDS.

" } }, "code": { "target": "com.amazonaws.health#eventTypeCode", "traits": { "smithy.api#documentation": "

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION\n ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } }, "category": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "actionability": { "target": "com.amazonaws.health#EventTypeActionability", "traits": { "smithy.api#documentation": "

The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required.\nEvents with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

" } }, "personas": { "target": "com.amazonaws.health#EventTypePersonaList", "traits": { "smithy.api#documentation": "

A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

" } } }, "traits": { "smithy.api#documentation": "

Contains the metadata about a type of event that is reported by Health. The\n EventType shows the category, service, and the event type code of the\n event. For example, an issue might be the category, EC2 the\n service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

\n

You can use the DescribeEventTypes API operation to return this information\n about an event.

\n

You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or\n take action when Health delivers a specific event to your Amazon Web Services account. For more\n information, see Monitor for Health events with Amazon CloudWatch Events in the\n Health User Guide.

" } }, "com.amazonaws.health#EventType2": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 }, "smithy.api#pattern": "^[^:/]{3,100}$" } }, "com.amazonaws.health#EventTypeActionability": { "type": "enum", "members": { "ACTION_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_REQUIRED" } }, "ACTION_MAY_BE_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTION_MAY_BE_REQUIRED" } }, "INFORMATIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INFORMATIONAL" } } } }, "com.amazonaws.health#EventTypeActionabilityList": { "type": "list", "member": { "target": "com.amazonaws.health#EventTypeActionability" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.health#EventTypeCategoryList": { "type": "list", "member": { "target": "com.amazonaws.health#eventTypeCategory" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#EventTypeCodeList": { "type": "list", "member": { "target": "com.amazonaws.health#eventTypeCode" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#EventTypeFilter": { "type": "structure", "members": { "eventTypeCodes": { "target": "com.amazonaws.health#EventTypeCodeList", "traits": { "smithy.api#documentation": "

A list of event type codes.

" } }, "services": { "target": "com.amazonaws.health#serviceList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "eventTypeCategories": { "target": "com.amazonaws.health#EventTypeCategoryList", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "actionabilities": { "target": "com.amazonaws.health#EventTypeActionabilityList", "traits": { "smithy.api#documentation": "

A list of actionability values to filter event types. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL.

" } }, "personas": { "target": "com.amazonaws.health#EventTypePersonaList", "traits": { "smithy.api#documentation": "

A list of persona classifications to filter event types. Possible values are OPERATIONS, SECURITY, and BILLING.

" } } }, "traits": { "smithy.api#documentation": "

The values to use to filter results from the DescribeEventTypes\n operation.

" } }, "com.amazonaws.health#EventTypeList": { "type": "list", "member": { "target": "com.amazonaws.health#EventType" } }, "com.amazonaws.health#EventTypePersona": { "type": "enum", "members": { "OPERATIONS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPERATIONS" } }, "SECURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITY" } }, "BILLING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BILLING" } } } }, "com.amazonaws.health#EventTypePersonaList": { "type": "list", "member": { "target": "com.amazonaws.health#EventTypePersona" }, "traits": { "smithy.api#length": { "min": 1, "max": 3 } } }, "com.amazonaws.health#ImpactRiskList": { "type": "list", "member": { "target": "com.amazonaws.health#string" } }, "com.amazonaws.health#InvalidPaginationToken": { "type": "structure", "members": { "message": { "target": "com.amazonaws.health#string" } }, "traits": { "smithy.api#documentation": "

The specified pagination token (nextToken) is not valid.

", "smithy.api#error": "client" } }, "com.amazonaws.health#LifecycleEvent": { "type": "structure", "members": { "lifecycleEventType": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The type of lifecycle event (for example, end-of-support, end-of-life).

" } }, "date": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The date of the lifecycle event.

" } }, "regions": { "target": "com.amazonaws.health#regionList", "traits": { "smithy.api#documentation": "

The Amazon Web Services Regions affected by this lifecycle event.

" } }, "impactRisks": { "target": "com.amazonaws.health#ImpactRiskList", "traits": { "smithy.api#documentation": "

The potential impact risks associated with this lifecycle event.

" } }, "description": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

A description of the lifecycle event.

" } } }, "traits": { "smithy.api#documentation": "

A lifecycle event for an Amazon Web Services service version, such as end-of-support or end-of-life.

" } }, "com.amazonaws.health#LifecycleEventList": { "type": "list", "member": { "target": "com.amazonaws.health#LifecycleEvent" } }, "com.amazonaws.health#LifecycleMaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 20 } } }, "com.amazonaws.health#OrganizationAccountIdsList": { "type": "list", "member": { "target": "com.amazonaws.health#accountId" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.health#OrganizationAffectedEntitiesErrorItem": { "type": "structure", "members": { "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "errorName": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The name of the error.

" } }, "errorMessage": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

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

\n

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

" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.health#OrganizationEntityAccountFiltersList": { "type": "list", "member": { "target": "com.amazonaws.health#EntityAccountFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#OrganizationEntityAggregate": { "type": "structure", "members": { "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

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\"\n

" } }, "count": { "target": "com.amazonaws.health#count", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "

The number of entities for the organization that match the filter criteria for the specified events.

" } }, "statuses": { "target": "com.amazonaws.health#entityStatuses", "traits": { "smithy.api#documentation": "

The number of affected entities aggregated by the entitiy status codes.

" } }, "accounts": { "target": "com.amazonaws.health#AccountEntityAggregatesList", "traits": { "smithy.api#documentation": "

A list of entity aggregates for each of the specified accounts in your organization that are affected by\n a specific event. If there are no awsAccountIds provided in the request, this field will be empty in the response.

" } } }, "traits": { "smithy.api#documentation": "

The aggregate results of entities affected by the specified event in your organization.\n The results are aggregated by the entity status codes for the specified set of accountsIDs.

" } }, "com.amazonaws.health#OrganizationEntityAggregateFilter": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.health#OrganizationEntityAggregateTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.

\n

Only entities whose tags match are included in the aggregates.

" } } }, "traits": { "smithy.api#documentation": "

A filter for narrowing down the entity aggregates returned by DescribeEntityAggregatesForOrganization.

" } }, "com.amazonaws.health#OrganizationEntityAggregateTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#OrganizationEntityAggregateTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#OrganizationEntityAggregateTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#OrganizationEntityAggregatesList": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationEntityAggregate" } }, "com.amazonaws.health#OrganizationEntityFiltersList": { "type": "list", "member": { "target": "com.amazonaws.health#EventAccountFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#OrganizationEvent": { "type": "structure", "members": { "arn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The Amazon Web Services service that is affected by the event, such as EC2 and RDS.

" } }, "eventTypeCode": { "target": "com.amazonaws.health#eventTypeCode", "traits": { "smithy.api#documentation": "

The unique identifier for the event type. The format is\n AWS_SERVICE_DESCRIPTION. For example,\n AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" } }, "eventTypeCategory": { "target": "com.amazonaws.health#eventTypeCategory", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "eventScopeCode": { "target": "com.amazonaws.health#eventScopeCode", "traits": { "smithy.api#documentation": "

This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

\n " } }, "region": { "target": "com.amazonaws.health#region", "traits": { "smithy.api#documentation": "

The Amazon Web Services Region name of the event.

" } }, "startTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The date and time that the event began.

" } }, "endTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The date and time that the event ended.

" } }, "lastUpdatedTime": { "target": "com.amazonaws.health#timestamp", "traits": { "smithy.api#documentation": "

The most recent date and time that the event was updated.

" } }, "statusCode": { "target": "com.amazonaws.health#eventStatusCode", "traits": { "smithy.api#documentation": "

The most recent status of the event. Possible values are open,\n closed, and upcoming.

" } }, "actionability": { "target": "com.amazonaws.health#EventActionability", "traits": { "smithy.api#documentation": "

The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required.\nEvents with INFORMATIONAL actionability are provided for awareness and do not require immediate action.

" } }, "personas": { "target": "com.amazonaws.health#EventPersonaList", "traits": { "smithy.api#documentation": "

A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.

" } } }, "traits": { "smithy.api#documentation": "

Summary information about an event, returned by the DescribeEventsForOrganization operation.

" } }, "com.amazonaws.health#OrganizationEventArnsList": { "type": "list", "member": { "target": "com.amazonaws.health#eventArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 25 } } }, "com.amazonaws.health#OrganizationEventDetailFiltersList": { "type": "list", "member": { "target": "com.amazonaws.health#EventAccountFilter" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#OrganizationEventDetails": { "type": "structure", "members": { "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

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

" } }, "event": { "target": "com.amazonaws.health#Event" }, "eventDescription": { "target": "com.amazonaws.health#EventDescription" }, "eventMetadata": { "target": "com.amazonaws.health#eventMetadata", "traits": { "smithy.api#documentation": "

Additional metadata about the event.

" } } }, "traits": { "smithy.api#documentation": "

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by\n the DescribeEventDetailsForOrganization operation.

" } }, "com.amazonaws.health#OrganizationEventDetailsErrorItem": { "type": "structure", "members": { "awsAccountId": { "target": "com.amazonaws.health#accountId", "traits": { "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified\n event.

" } }, "eventArn": { "target": "com.amazonaws.health#eventArn", "traits": { "smithy.api#documentation": "

The unique identifier for the event. The event ARN has the\narn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID\n \nformat.

\n

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

\n

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

" } }, "errorName": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The name of the error.

" } }, "errorMessage": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

A message that describes the error.

\n

If you call the DescribeEventDetailsForOrganization operation and receive one of the following errors, follow the recommendations in the message:

\n " } } }, "traits": { "smithy.api#documentation": "

Error information returned when a DescribeEventDetailsForOrganization operation can't find a specified\n event.

" } }, "com.amazonaws.health#OrganizationEventFilter": { "type": "structure", "members": { "actionabilities": { "target": "com.amazonaws.health#EventActionabilityList", "traits": { "smithy.api#documentation": "

A list of actionability values to filter events. Use this to filter events based on whether they require action (ACTION_REQUIRED), may require action (ACTION_MAY_BE_REQUIRED) or are informational (INFORMATIONAL).

" } }, "eventTypeCodes": { "target": "com.amazonaws.health#eventTypeList2", "traits": { "smithy.api#documentation": "

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\".\n

" } }, "awsAccountIds": { "target": "com.amazonaws.health#awsAccountIdsList", "traits": { "smithy.api#documentation": "

A list of 12-digit Amazon Web Services account numbers that contains the affected entities.

" } }, "services": { "target": "com.amazonaws.health#serviceList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services associated with the event. For example, EC2, RDS.

" } }, "regions": { "target": "com.amazonaws.health#regionList", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services Regions.

" } }, "startTime": { "target": "com.amazonaws.health#DateTimeRange" }, "endTime": { "target": "com.amazonaws.health#DateTimeRange" }, "lastUpdatedTime": { "target": "com.amazonaws.health#DateTimeRange" }, "entityArns": { "target": "com.amazonaws.health#entityArnList", "traits": { "smithy.api#documentation": "

A list of entity ARNs (unique identifiers).

" } }, "entityValues": { "target": "com.amazonaws.health#entityValueList", "traits": { "smithy.api#documentation": "

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

" } }, "eventTypeCategories": { "target": "com.amazonaws.health#eventTypeCategoryList2", "traits": { "smithy.api#documentation": "

A list of event type category codes. Possible values are\nissue, accountNotification, or scheduledChange. Currently,\nthe investigation value isn't supported at this time.

" } }, "eventStatusCodes": { "target": "com.amazonaws.health#eventStatusCodeList", "traits": { "smithy.api#documentation": "

A list of event status codes.

" } }, "personas": { "target": "com.amazonaws.health#EventPersonaList", "traits": { "smithy.api#documentation": "

A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.

" } }, "tags": { "target": "com.amazonaws.health#OrganizationEventTagFilter", "traits": { "smithy.api#documentation": "

A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.

\n

An event is returned when one of its affected accounts, or one of the entities of those accounts, has tags that match.

" } } }, "traits": { "smithy.api#documentation": "

The values to filter results from the DescribeEventsForOrganization operation.

" } }, "com.amazonaws.health#OrganizationEventList": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationEvent" } }, "com.amazonaws.health#OrganizationEventTagFilter": { "type": "map", "key": { "target": "com.amazonaws.health#TagFilterKey" }, "value": { "target": "com.amazonaws.health#OrganizationEventTagValueList" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#OrganizationEventTagValueList": { "type": "list", "member": { "target": "com.amazonaws.health#TagFilterValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#OrganizationTag": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#tagKey", "traits": { "smithy.api#documentation": "

The tag key.

" } }, "value": { "target": "com.amazonaws.health#tagValue", "traits": { "smithy.api#documentation": "

The tag value.

" } }, "type": { "target": "com.amazonaws.health#OrganizationTagType", "traits": { "smithy.api#documentation": "

The type of organization tag.

" } } }, "traits": { "smithy.api#documentation": "

A tag key-value pair associated with a resource across an organization.

" } }, "com.amazonaws.health#OrganizationTagKey": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#OrganizationTagKey2", "traits": { "smithy.api#documentation": "

The tag key name.

" } }, "enabledForEventBridge": { "target": "com.amazonaws.health#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Whether this tag key is enabled for EventBridge notifications.

" } }, "status": { "target": "com.amazonaws.health#TagKeyStatus", "traits": { "smithy.api#documentation": "

The current status of the tag key configuration.

" } } }, "traits": { "smithy.api#documentation": "

A tag key configured for Health event tracking across an organization.

" } }, "com.amazonaws.health#OrganizationTagKey2": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:/=+\\-@]{1,127}$" } }, "com.amazonaws.health#OrganizationTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationTagKey" } }, "com.amazonaws.health#OrganizationTagList": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationTag" } }, "com.amazonaws.health#OrganizationTagType": { "type": "enum", "members": { "ORGANIZATION_RESOURCE_TAG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_RESOURCE_TAG" } }, "ORGANIZATION_ACCOUNT_TAG": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORGANIZATION_ACCOUNT_TAG" } } } }, "com.amazonaws.health#OrganizationTagTypeFilter": { "type": "list", "member": { "target": "com.amazonaws.health#OrganizationTagType" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.health#ResourceTagKey": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#ResourceTagKey2", "traits": { "smithy.api#documentation": "

The tag key name.

" } }, "enabledForEventBridge": { "target": "com.amazonaws.health#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Whether this tag key is enabled for EventBridge notifications.

" } }, "status": { "target": "com.amazonaws.health#TagKeyStatus", "traits": { "smithy.api#documentation": "

The current status of the tag key configuration.

" } } }, "traits": { "smithy.api#documentation": "

A resource tag key configured for Health event tracking.

" } }, "com.amazonaws.health#ResourceTagKey2": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{1,127}$" } }, "com.amazonaws.health#ResourceTagKeyList": { "type": "list", "member": { "target": "com.amazonaws.health#ResourceTagKey" } }, "com.amazonaws.health#ResourceTagSet": { "type": "map", "key": { "target": "com.amazonaws.health#ResourceTagKey2" }, "value": { "target": "com.amazonaws.health#ResourceTagValue" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.health#ResourceTagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{0,255}$" } }, "com.amazonaws.health#ServiceLifecycle": { "type": "structure", "members": { "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The name of the Amazon Web Services service.

" } }, "version": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The version of the service.

" } }, "title": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

A human-readable title for the lifecycle entry.

" } }, "recommendedVersion": { "target": "com.amazonaws.health#string", "traits": { "smithy.api#documentation": "

The recommended version to upgrade to.

" } }, "lifecycleEvents": { "target": "com.amazonaws.health#LifecycleEventList", "traits": { "smithy.api#documentation": "

The list of lifecycle events for this service version.

" } } }, "traits": { "smithy.api#documentation": "

Contains lifecycle information for an Amazon Web Services service version, including lifecycle events and version recommendations.

" } }, "com.amazonaws.health#ServiceLifecycleFilter": { "type": "structure", "members": { "service": { "target": "com.amazonaws.health#service", "traits": { "smithy.api#documentation": "

The Amazon Web Services service name to filter by.

" } } }, "traits": { "smithy.api#documentation": "

A filter for narrowing down service lifecycle results.

" } }, "com.amazonaws.health#ServiceLifecycleList": { "type": "list", "member": { "target": "com.amazonaws.health#ServiceLifecycle" } }, "com.amazonaws.health#TagFilterKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 127 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{1,127}$" } }, "com.amazonaws.health#TagFilterValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9 _.:\\/=+\\-@]{0,255}$" } }, "com.amazonaws.health#TagKeyForOrganization": { "type": "structure", "members": { "key": { "target": "com.amazonaws.health#OrganizationTagKey2", "traits": { "smithy.api#documentation": "

The tag key name.

", "smithy.api#required": {} } }, "enabledForEventBridge": { "target": "com.amazonaws.health#Boolean", "traits": { "smithy.api#default": false, "smithy.api#documentation": "

Whether this tag key is enabled for EventBridge notifications.

" } } }, "traits": { "smithy.api#documentation": "

A tag key configured for an organization.

" } }, "com.amazonaws.health#TagKeyStatus": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } } } }, "com.amazonaws.health#TagsOnboardingStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.health#TagsOnboardingStatusForOrganization": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.health#UnsupportedLocale": { "type": "structure", "members": { "message": { "target": "com.amazonaws.health#string" } }, "traits": { "smithy.api#documentation": "

The specified locale is not supported.

", "smithy.api#error": "client" } }, "com.amazonaws.health#accountId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 12 }, "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.health#affectedAccountsList": { "type": "list", "member": { "target": "com.amazonaws.health#accountId" } }, "com.amazonaws.health#aggregateValue": { "type": "string" }, "com.amazonaws.health#availabilityZone": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 18 }, "smithy.api#pattern": "^[a-z]{2,4}\\-[0-9a-z\\-]{4,16}$" } }, "com.amazonaws.health#availabilityZones": { "type": "list", "member": { "target": "com.amazonaws.health#availabilityZone" } }, "com.amazonaws.health#awsAccountIdsList": { "type": "list", "member": { "target": "com.amazonaws.health#accountId" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.health#count": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.health#dateTimeRangeList": { "type": "list", "member": { "target": "com.amazonaws.health#DateTimeRange" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#entityArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#pattern": "^.{0,1600}$" } }, "com.amazonaws.health#entityArnList": { "type": "list", "member": { "target": "com.amazonaws.health#entityArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 99 } } }, "com.amazonaws.health#entityMetadata": { "type": "map", "key": { "target": "com.amazonaws.health#entityMetadataKey" }, "value": { "target": "com.amazonaws.health#entityMetadataValue" } }, "com.amazonaws.health#entityMetadataKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.health#entityMetadataValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 } } }, "com.amazonaws.health#entityStatusCode": { "type": "enum", "members": { "IMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPAIRED" } }, "UNIMPAIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNIMPAIRED" } }, "UNKNOWN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "RESOLVED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOLVED" } } } }, "com.amazonaws.health#entityStatusCodeList": { "type": "list", "member": { "target": "com.amazonaws.health#entityStatusCode" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.health#entityStatuses": { "type": "map", "key": { "target": "com.amazonaws.health#entityStatusCode" }, "value": { "target": "com.amazonaws.health#count" } }, "com.amazonaws.health#entityUrl": { "type": "string" }, "com.amazonaws.health#entityValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1224 }, "smithy.api#pattern": "^.{0,1224}$" } }, "com.amazonaws.health#entityValueList": { "type": "list", "member": { "target": "com.amazonaws.health#entityValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 99 } } }, "com.amazonaws.health#eventAggregateField": { "type": "enum", "members": { "EventTypeCategory": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "eventTypeCategory" } } } }, "com.amazonaws.health#eventArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1600 }, "smithy.api#pattern": "^arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\\w-]+){3}$" } }, "com.amazonaws.health#eventArnList": { "type": "list", "member": { "target": "com.amazonaws.health#eventArn" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#eventMetadata": { "type": "map", "key": { "target": "com.amazonaws.health#metadataKey" }, "value": { "target": "com.amazonaws.health#metadataValue" } }, "com.amazonaws.health#eventScopeCode": { "type": "enum", "members": { "PUBLIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLIC" } }, "ACCOUNT_SPECIFIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCOUNT_SPECIFIC" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.health#eventStatusCode": { "type": "enum", "members": { "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "open" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "closed" } }, "UPCOMING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "upcoming" } } } }, "com.amazonaws.health#eventStatusCodeList": { "type": "list", "member": { "target": "com.amazonaws.health#eventStatusCode" }, "traits": { "smithy.api#length": { "min": 1, "max": 6 } } }, "com.amazonaws.health#eventTypeCategory": { "type": "enum", "members": { "ISSUE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "issue" } }, "ACCOUNT_NOTIFICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "accountNotification" } }, "SCHEDULED_CHANGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "scheduledChange" } }, "INVESTIGATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "investigation" } } }, "traits": { "smithy.api#length": { "min": 3, "max": 255 } } }, "com.amazonaws.health#eventTypeCategoryList2": { "type": "list", "member": { "target": "com.amazonaws.health#eventTypeCategory" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#eventTypeCode": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-]{3,100}$" } }, "com.amazonaws.health#eventTypeList2": { "type": "list", "member": { "target": "com.amazonaws.health#EventType2" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#healthServiceAccessStatusForOrganization": { "type": "string" }, "com.amazonaws.health#locale": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 256 }, "smithy.api#pattern": "^.{2,256}$" } }, "com.amazonaws.health#maxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 10, "max": 100 } } }, "com.amazonaws.health#maxResultsLowerRange": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.health#metadataKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32766 } } }, "com.amazonaws.health#metadataValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32766 } } }, "com.amazonaws.health#nextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 4, "max": 10000 }, "smithy.api#pattern": "^[a-zA-Z0-9=/+_.-]{4,10000}$" } }, "com.amazonaws.health#region": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 25 }, "smithy.api#pattern": "^[^:/]{2,25}$" } }, "com.amazonaws.health#regionList": { "type": "list", "member": { "target": "com.amazonaws.health#region" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#service": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 30 }, "smithy.api#pattern": "^[^:/]{2,30}$" } }, "com.amazonaws.health#serviceList": { "type": "list", "member": { "target": "com.amazonaws.health#service" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.health#string": { "type": "string" }, "com.amazonaws.health#tagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 127 }, "smithy.api#pattern": "^.{0,127}$" } }, "com.amazonaws.health#tagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^.{0,255}$" } }, "com.amazonaws.health#timestamp": { "type": "timestamp" } } }