2026/08/04 - Amazon Elastic Compute Cloud - 10 new9 updated api methods
Changes Amazon EC2 now supports Application Status Checks, a new status check that monitors your application's health through configurable HTTP(S) paths and ports, so you can detect and automatically respond to application-level impairments.
Disassociates an application status check from instances or tags. After disassociation, health monitoring stops for the affected instances. The following rules apply:
You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error.
The application status check must already exist and belong to your account.
Tag keys must not be blank.
See also: AWS API Documentation
Request Syntax
client.disassociate_application_status_check(
ApplicationStatusCheckId='string',
TargetTagAssociations=[
{
'Key': 'string',
'Value': 'string'
},
],
InstanceIds=[
'string',
],
ClientToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the application status check to disassociate.
list
The tags to disassociate from the application status check. Specify the same key-value pairs that were used during association.
(dict) --
Describes a tag key-value pair for an application status check association request.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
list
The IDs of the instances to disassociate from the application status check.
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'SuccessfulResults': [
{
'ApplicationStatusCheckId': 'string',
'AssociationType': 'string',
'AssociationValue': 'string'
},
],
'UnsuccessfulResults': [
{
'ApplicationStatusCheckId': 'string',
'AssociationType': 'string',
'AssociationValue': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulResults (list) --
The associations that were successfully removed.
(dict) --
Describes a successful application status check association.
ApplicationStatusCheckId (string) --
The ID of the application status check.
AssociationType (string) --
The type of association. Valid values: EC2TAG and INSTANCE_ID.
AssociationValue (string) --
The association value. For EC2TAG, the value is formatted as key=value. For INSTANCE_ID, the value is the instance ID.
UnsuccessfulResults (list) --
The associations that failed to be removed.
(dict) --
Describes an unsuccessful application status check association.
ApplicationStatusCheckId (string) --
The ID of the application status check.
AssociationType (string) --
The type of association. Valid values: EC2TAG and INSTANCE_ID.
AssociationValue (string) --
The association value. For EC2TAG, the value is formatted as key=value. For INSTANCE_ID, the value is the instance ID.
Reason (string) --
The reason the association failed.
Disables suppression of application status checks for the specified instances. After suppression is disabled, health check results resume affecting the instance-level application status. You can specify a maximum of 100 instance IDs per request.
See also: AWS API Documentation
Request Syntax
client.disable_application_status_check_suppression(
InstanceIds=[
'string',
],
ClientToken='string',
DryRun=True|False
)
list
The IDs of the instances for which to disable application status check suppression.
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'SuccessfulResults': [
{
'InstanceId': 'string',
'SuppressAt': datetime(2015, 1, 1),
'ResumeAt': datetime(2015, 1, 1)
},
],
'UnsuccessfulResults': [
{
'InstanceId': 'string',
'SuppressAt': datetime(2015, 1, 1),
'ResumeAt': datetime(2015, 1, 1),
'Reason': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulResults (list) --
The instances for which suppression was successfully disabled.
(dict) --
Describes a successful application status check suppression.
InstanceId (string) --
The ID of the instance.
SuppressAt (datetime) --
The date and time when suppression started.
ResumeAt (datetime) --
The date and time when suppression ends and health checks resume.
UnsuccessfulResults (list) --
The instances for which suppression failed to be disabled.
(dict) --
Describes an unsuccessful application status check suppression.
InstanceId (string) --
The ID of the instance.
SuppressAt (datetime) --
The date and time when suppression was attempted.
ResumeAt (datetime) --
The date and time when health checks would have resumed.
Reason (string) --
The reason the suppression failed.
Describes one or more application status checks. Returns configuration details for your application status checks, including protocol, port, path, thresholds, and associations. The following rules apply:
If you do not specify any application status check IDs, all checks in your account are returned.
Use DescribeApplicationStatus to see the actual health status of instances.
See also: AWS API Documentation
Request Syntax
client.describe_application_status_checks(
ApplicationStatusCheckIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
IncludeAll=True|False,
DryRun=True|False
)
list
The IDs of the application status checks to describe.
(string) --
list
The filters.
aggregation – The aggregation setting. Valid values: included and excluded.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to false, the response includes only active checks.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'ApplicationStatusChecks': [
{
'ApplicationStatusCheckId': 'string',
'Aggregation': 'included'|'excluded',
'HealthCheckPaths': [
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
'Protocol': 'http'|'https',
'Port': 123,
'Path': 'string',
'DeviceIndex': 123,
'IpVersion': 'ipv4'|'ipv6',
'IpScope': 'private',
'Interval': 123,
'Timeout': 123,
'FailureThreshold': 123,
'SuccessThreshold': 123,
'StatusCodeMatcher': 'string',
'InitializationGracePeriodSeconds': 123,
'LastUpdatedAt': datetime(2015, 1, 1),
'TargetTagAssociations': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ModifyTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationStatusChecks (list) --
Information about the application status checks.
(dict) --
Describes an application status check.
ApplicationStatusCheckId (string) --
The ID of the application status check.
Aggregation (string) --
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
HealthCheckPaths (list) --
The health check paths for the application status check.
(dict) --
Describes a health check path for an application status check.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
Protocol (string) --
The protocol used for the health check.
Port (integer) --
The port used for the health check.
Path (string) --
The URL path used for the health check HTTP request.
DeviceIndex (integer) --
The index of the network device used for the health check. The value is greater than or equal to 0.
IpVersion (string) --
The IP version used for the health check.
IpScope (string) --
The IP scope used for the health check.
Interval (integer) --
The interval, in seconds, between health checks. Valid value: 60.
Timeout (integer) --
The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.
FailureThreshold (integer) --
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
SuccessThreshold (integer) --
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
StatusCodeMatcher (string) --
The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.
InitializationGracePeriodSeconds (integer) --
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
LastUpdatedAt (datetime) --
The date and time when the application status check was last updated.
TargetTagAssociations (list) --
The tags associated with the application status check. Instances with these tags are automatically monitored by this check.
(dict) --
Describes a tag key-value pair for an application status check association.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Tags (list) --
The tags assigned to the application status check.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
CreationTime (datetime) --
The date and time when the application status check was created.
ModifyTime (datetime) --
The date and time when the application status check was last modified.
DeletionTime (datetime) --
The date and time when the application status check was deleted.
NextToken (string) --
The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.
Creates an application status check for monitoring the health of applications running on your instances. You can configure the protocol, port, path, and thresholds for the health check. The following rules apply:
You can create a maximum of 50 application status checks per account.
Health checks do not start until you associate the check with instances or tags using AssociateApplicationStatusCheck.
The Timeout value must be less than the Interval value.
The Path must start with a forward slash ( /). Default: /.
If you do not specify Aggregation, it defaults to included, which means the check contributes to the instance-level application status.
Default values: Interval is 60 seconds, Timeout is 6 seconds, FailureThreshold is 2, SuccessThreshold is 5, StatusCodeMatcher is 200, InitializationGracePeriodSeconds is 300 seconds.
You can tag the application status check during creation. For more information, see Tag your Amazon EC2 resources.
See also: AWS API Documentation
Request Syntax
client.create_application_status_check(
HealthCheckPaths=[
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
Aggregation='included'|'excluded',
Protocol='http'|'https',
Port=123,
Path='string',
DeviceIndex=123,
IpVersion='ipv4'|'ipv6',
IpScope='private',
Interval=123,
Timeout=123,
FailureThreshold=123,
SuccessThreshold=123,
StatusCodeMatcher='string',
InitializationGracePeriodSeconds=123,
TagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ClientToken='string',
DryRun=True|False
)
list
The health check paths to use for the application status check. Health check paths define the network path from a source subnet to one or more destination subnets for cross-Availability Zone or Availability Zone to Local Zone health checking. If omitted, health checks are performed in the same subnet as the instance.
(dict) --
Describes a health check path for an application status check request.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path in a request. Destinations can be in a different Availability Zone than the source (cross-AZ) or in a Local Zone (AZ to Local Zone), enabling remote health validation of your application.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
string
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
string
[REQUIRED]
The protocol to use for the health check. Valid values: http | https.
integer
[REQUIRED]
The port to use for the health check. Valid values: 1 to 65535.
string
The URL path to use for the health check HTTP request (for example, /health or /status).
integer
The index of the network device to use for the health check. The value must be greater than or equal to 0.
string
The IP version to use for the health check. Valid values: ipv4 and ipv6.
string
The IP scope to use for the health check. Valid value: private.
integer
The interval, in seconds, between health checks. Valid value: 60.
integer
The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.
integer
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
integer
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
string
The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters. Default: 200.
integer
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
list
The tags to apply to the application status check.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'ApplicationStatusCheck': {
'ApplicationStatusCheckId': 'string',
'Aggregation': 'included'|'excluded',
'HealthCheckPaths': [
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
'Protocol': 'http'|'https',
'Port': 123,
'Path': 'string',
'DeviceIndex': 123,
'IpVersion': 'ipv4'|'ipv6',
'IpScope': 'private',
'Interval': 123,
'Timeout': 123,
'FailureThreshold': 123,
'SuccessThreshold': 123,
'StatusCodeMatcher': 'string',
'InitializationGracePeriodSeconds': 123,
'LastUpdatedAt': datetime(2015, 1, 1),
'TargetTagAssociations': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ModifyTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ApplicationStatusCheck (dict) --
Information about the application status check.
ApplicationStatusCheckId (string) --
The ID of the application status check.
Aggregation (string) --
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
HealthCheckPaths (list) --
The health check paths for the application status check.
(dict) --
Describes a health check path for an application status check.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
Protocol (string) --
The protocol used for the health check.
Port (integer) --
The port used for the health check.
Path (string) --
The URL path used for the health check HTTP request.
DeviceIndex (integer) --
The index of the network device used for the health check. The value is greater than or equal to 0.
IpVersion (string) --
The IP version used for the health check.
IpScope (string) --
The IP scope used for the health check.
Interval (integer) --
The interval, in seconds, between health checks. Valid value: 60.
Timeout (integer) --
The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.
FailureThreshold (integer) --
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
SuccessThreshold (integer) --
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
StatusCodeMatcher (string) --
The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.
InitializationGracePeriodSeconds (integer) --
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
LastUpdatedAt (datetime) --
The date and time when the application status check was last updated.
TargetTagAssociations (list) --
The tags associated with the application status check. Instances with these tags are automatically monitored by this check.
(dict) --
Describes a tag key-value pair for an application status check association.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Tags (list) --
The tags assigned to the application status check.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
CreationTime (datetime) --
The date and time when the application status check was created.
ModifyTime (datetime) --
The date and time when the application status check was last modified.
DeletionTime (datetime) --
The date and time when the application status check was deleted.
Modifies an existing application status check. You can update the protocol, port, path, thresholds, and other configuration settings. The following rules apply:
The application status check must exist and belong to your account.
Changes take effect on the next health check interval.
See also: AWS API Documentation
Request Syntax
client.modify_application_status_check(
ApplicationStatusCheckId='string',
Aggregation='included'|'excluded',
HealthCheckPaths=[
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
Protocol='http'|'https',
Port=123,
Path='string',
DeviceIndex=123,
IpVersion='ipv4'|'ipv6',
IpScope='private',
Interval=123,
Timeout=123,
FailureThreshold=123,
SuccessThreshold=123,
StatusCodeMatcher='string',
InitializationGracePeriodSeconds=123,
ClientToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the application status check to modify.
string
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
list
The health check paths to use for the application status check.
(dict) --
Describes a health check path for an application status check request.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path in a request. Destinations can be in a different Availability Zone than the source (cross-AZ) or in a Local Zone (AZ to Local Zone), enabling remote health validation of your application.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
string
The protocol to use for the health check. Valid values: http | https.
integer
The port to use for the health check. Valid values: 1 to 65535.
string
The URL path to use for the health check HTTP request (for example, /health or /status).
integer
The index of the network device to use for the health check. The value must be greater than or equal to 0.
string
The IP version to use for the health check. Valid values: ipv4 and ipv6.
string
The IP scope to use for the health check. Valid value: private.
integer
The interval, in seconds, between health checks. Valid value: 60.
integer
The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.
integer
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
integer
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
string
The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters.
integer
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'ApplicationStatusCheck': {
'ApplicationStatusCheckId': 'string',
'Aggregation': 'included'|'excluded',
'HealthCheckPaths': [
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
'Protocol': 'http'|'https',
'Port': 123,
'Path': 'string',
'DeviceIndex': 123,
'IpVersion': 'ipv4'|'ipv6',
'IpScope': 'private',
'Interval': 123,
'Timeout': 123,
'FailureThreshold': 123,
'SuccessThreshold': 123,
'StatusCodeMatcher': 'string',
'InitializationGracePeriodSeconds': 123,
'LastUpdatedAt': datetime(2015, 1, 1),
'TargetTagAssociations': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ModifyTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ApplicationStatusCheck (dict) --
Information about the modified application status check.
ApplicationStatusCheckId (string) --
The ID of the application status check.
Aggregation (string) --
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
HealthCheckPaths (list) --
The health check paths for the application status check.
(dict) --
Describes a health check path for an application status check.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
Protocol (string) --
The protocol used for the health check.
Port (integer) --
The port used for the health check.
Path (string) --
The URL path used for the health check HTTP request.
DeviceIndex (integer) --
The index of the network device used for the health check. The value is greater than or equal to 0.
IpVersion (string) --
The IP version used for the health check.
IpScope (string) --
The IP scope used for the health check.
Interval (integer) --
The interval, in seconds, between health checks. Valid value: 60.
Timeout (integer) --
The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.
FailureThreshold (integer) --
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
SuccessThreshold (integer) --
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
StatusCodeMatcher (string) --
The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.
InitializationGracePeriodSeconds (integer) --
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
LastUpdatedAt (datetime) --
The date and time when the application status check was last updated.
TargetTagAssociations (list) --
The tags associated with the application status check. Instances with these tags are automatically monitored by this check.
(dict) --
Describes a tag key-value pair for an application status check association.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Tags (list) --
The tags assigned to the application status check.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
CreationTime (datetime) --
The date and time when the application status check was created.
ModifyTime (datetime) --
The date and time when the application status check was last modified.
DeletionTime (datetime) --
The date and time when the application status check was deleted.
Associates an application status check with instances or tags. Once you create an association, health monitoring automatically begins for the specified instances or for instances that match the specified tags. The following rules apply:
You must specify either TargetTagAssociations or InstanceIds, but not both. Specifying both results in an InvalidParameterCombination error.
The application status check must already exist and belong to your account.
Tag keys must not be blank.
Maximum 50 tag associations per application status check.
Use DisassociateApplicationStatusCheck to remove associations.
When you associate tags, the application status check automatically monitors all current and future instances that have the specified tags.
See also: AWS API Documentation
Request Syntax
client.associate_application_status_check(
ApplicationStatusCheckId='string',
TargetTagAssociations=[
{
'Key': 'string',
'Value': 'string'
},
],
InstanceIds=[
'string',
],
ClientToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the application status check to associate.
list
The tags to associate the application status check with. Each tag is a key-value pair. When you associate tags, the application status check automatically monitors all instances that have the specified tags.
(dict) --
Describes a tag key-value pair for an application status check association request.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
list
The IDs of the instances to associate with the application status check.
(string) --
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'SuccessfulResults': [
{
'ApplicationStatusCheckId': 'string',
'AssociationType': 'string',
'AssociationValue': 'string'
},
],
'UnsuccessfulResults': [
{
'ApplicationStatusCheckId': 'string',
'AssociationType': 'string',
'AssociationValue': 'string',
'Reason': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulResults (list) --
The associations that were successfully created.
(dict) --
Describes a successful application status check association.
ApplicationStatusCheckId (string) --
The ID of the application status check.
AssociationType (string) --
The type of association. Valid values: EC2TAG and INSTANCE_ID.
AssociationValue (string) --
The association value. For EC2TAG, the value is formatted as key=value. For INSTANCE_ID, the value is the instance ID.
UnsuccessfulResults (list) --
The associations that failed to be created.
(dict) --
Describes an unsuccessful application status check association.
ApplicationStatusCheckId (string) --
The ID of the application status check.
AssociationType (string) --
The type of association. Valid values: EC2TAG and INSTANCE_ID.
AssociationValue (string) --
The association value. For EC2TAG, the value is formatted as key=value. For INSTANCE_ID, the value is the instance ID.
Reason (string) --
The reason the association failed.
Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply:
The instance-level status is derived from all application status checks with the aggregation setting set to included.
Use DescribeApplicationStatusChecks to view the configuration of individual checks.
Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status.
See also: AWS API Documentation
Request Syntax
client.describe_application_status(
InstanceIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the instances for which to describe application status.
(string) --
list
The filters.
availability-zone-id – The ID of the Availability Zone.
status – The instance-level application status. For valid values and their meanings, see ApplicationStatus.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'ApplicationStatuses': {
'Instances': [
{
'InstanceId': 'string',
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'ApplicationStatus': {
'Status': 'ok'|'impaired'|'initializing'|'insufficient-data'|'not-applicable'|'suppressed',
'StatusTimeStamp': datetime(2015, 1, 1),
'StatusSince': datetime(2015, 1, 1),
'ResumeAt': datetime(2015, 1, 1),
'Details': [
{
'ApplicationStatusCheckId': 'string',
'CheckUpdateTime': datetime(2015, 1, 1),
'Aggregation': 'included'|'excluded',
'Status': 'passed'|'failed'|'initializing'|'insufficient-data'|'not-applicable',
'StatusTimeStamp': datetime(2015, 1, 1),
'StatusSince': datetime(2015, 1, 1),
'Reason': {
'Code': 'string',
'StatusCode': 123,
'Protocol': 'string'
}
},
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
ApplicationStatuses (dict) --
The application statuses for the specified instances.
Instances (list) --
The application status information for the instances.
(dict) --
Describes the application status for an instance.
InstanceId (string) --
The ID of the instance.
AvailabilityZone (string) --
The Availability Zone of the instance.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the instance.
ApplicationStatus (dict) --
The application status for the instance.
Status (string) --
The current instance-level application status. This status is derived from application status checks with Aggregation set to included. Possible values:
ok – All included checks passed.
impaired – At least one included check failed.
initializing – At least one included check is initializing, and no included check is impaired.
insufficient-data – At least one included check has insufficient data, and no included check is impaired or initializing.
not-applicable – No checks with Aggregation set to included apply to the instance.
suppressed – Application status reporting is suppressed for the instance.
Checks with Aggregation set to excluded do not affect this value.
StatusTimeStamp (datetime) --
The date and time of the last status update.
StatusSince (datetime) --
The date and time when the current status started.
ResumeAt (datetime) --
The date and time when application status reporting resumes after suppression.
Details (list) --
Details about the application status checks for the instance.
(dict) --
Describes the details of an application status check for an instance.
ApplicationStatusCheckId (string) --
The ID of the application status check.
CheckUpdateTime (datetime) --
The date and time when the check was last updated.
Aggregation (string) --
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
Status (string) --
The status of the individual application status check. Possible values:
passed – The check reached its success threshold.
failed – The check reached its failure threshold.
initializing – The check is initializing or has not reached a success or failure threshold.
insufficient-data – The check does not have enough data to determine a result.
not-applicable – The check does not apply to the instance.
This value reflects the check result and is not affected by aggregation or suppression.
StatusTimeStamp (datetime) --
The date and time of the last status update for this check.
StatusSince (datetime) --
The date and time when the current status started for this check.
Reason (dict) --
The reason for the current status.
Code (string) --
The reason code for the application status check result. Possible values:
ResponseCodeMatched – The HTTP status code returned by the health check matched the configured StatusCodeMatcher.
ResponseCodeMismatch – The HTTP status code returned by the health check did not match the configured StatusCodeMatcher.
ConnectionTimeout – The connection to the target timed out.
ResponseTimeout – The health check timed out while waiting for a response from the target.
ConnectionRefused – The target refused the health check connection.
ConnectionReset – The target reset the health check connection before returning a response.
Current health check results use the values in the preceding list. Legacy results that do not contain structured reason metadata can instead contain a producer error type, such as Http Status Code or HttpConnectTimeoutException.
For ResponseCodeMatched and ResponseCodeMismatch, the statusCode field contains the returned HTTP status code. The protocol field contains the protocol used for the health check.
StatusCode (integer) --
The HTTP status code returned by the health check.
Protocol (string) --
The protocol used for the health check. Possible values: HTTP and HTTPS.
Tags (list) --
The tags assigned to the instance.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
NextToken (string) --
The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.
Describes the associations for one or more application status checks. For more information, see Application status checks. To avoid timeouts and retrieve complete results, use the pagination parameters.
See also: AWS API Documentation
Request Syntax
client.describe_application_status_check_associations(
ApplicationStatusCheckIds=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string',
DryRun=True|False
)
list
The IDs of the application status checks for which to describe associations.
(string) --
list
The filters to use to limit the results.
association-type – The type of association. Valid values: tag and instance-id.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'Associations': [
{
'ApplicationStatusCheckId': 'string',
'AssociationType': 'tag'|'instance-id',
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
Associations (list) --
The associations for the specified application status checks.
(dict) --
Information about an application status check association. Each item in the associationSet of a DescribeApplicationStatusCheckAssociations response is of this type.
ApplicationStatusCheckId (string) --
The ID of the application status check.
AssociationType (string) --
The type of target that the application status check is associated with. Possible values:
tag – The check applies to current and future instances with a matching tag key-value pair.
instance-id – The check applies to a specific instance.
Key (string) --
The key for the association. This value is present only for tag-based associations, where it contains the tag key. For instance-based associations, this value is absent.
Value (string) --
The value for the association target. For tag-based associations, this is the tag value. For instance-based associations, this is the instance ID (for example, i-0123456789abcdef0).
NextToken (string) --
The token to include in another request to get the next page of items. This value is <code>null</code> when there are no more items to return.
Tags (list) --
The tags associated with the application status checks.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
Suppresses application status checks for the specified instances. While suppressed, health checks continue to run but do not affect the instance-level application status. The following rules apply:
Maximum 100 instance IDs per request.
Use DisableApplicationStatusCheckSuppression to resume normal health check reporting.
If you do not specify DurationSeconds, suppression continues indefinitely until you call DisableApplicationStatusCheckSuppression.
See also: AWS API Documentation
Request Syntax
client.enable_application_status_check_suppression(
InstanceIds=[
'string',
],
DurationSeconds=123,
ClientToken='string',
DryRun=True|False
)
list
The IDs of the instances for which to suppress application status checks.
(string) --
integer
The duration, in seconds, for which to suppress application status checks. If omitted, the application status check is suppressed indefinitely until you call DisableApplicationStatusCheckSuppression.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'SuccessfulResults': [
{
'InstanceId': 'string',
'SuppressAt': datetime(2015, 1, 1),
'ResumeAt': datetime(2015, 1, 1)
},
],
'UnsuccessfulResults': [
{
'InstanceId': 'string',
'SuppressAt': datetime(2015, 1, 1),
'ResumeAt': datetime(2015, 1, 1),
'Reason': 'string'
},
]
}
Response Structure
(dict) --
SuccessfulResults (list) --
The instances for which suppression was successfully enabled.
(dict) --
Describes a successful application status check suppression.
InstanceId (string) --
The ID of the instance.
SuppressAt (datetime) --
The date and time when suppression started.
ResumeAt (datetime) --
The date and time when suppression ends and health checks resume.
UnsuccessfulResults (list) --
The instances for which suppression failed to be enabled.
(dict) --
Describes an unsuccessful application status check suppression.
InstanceId (string) --
The ID of the instance.
SuppressAt (datetime) --
The date and time when suppression was attempted.
ResumeAt (datetime) --
The date and time when health checks would have resumed.
Reason (string) --
The reason the suppression failed.
Deletes an application status check. The following rules apply:
Deleting a check automatically removes all of its associations.
Use DescribeApplicationStatusChecks to view existing checks before deleting.
See also: AWS API Documentation
Request Syntax
client.delete_application_status_check(
ApplicationStatusCheckId='string',
ClientToken='string',
DryRun=True|False
)
string
[REQUIRED]
The ID of the application status check to delete.
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
dict
Response Syntax
{
'ApplicationStatusCheck': {
'ApplicationStatusCheckId': 'string',
'Aggregation': 'included'|'excluded',
'HealthCheckPaths': [
{
'Source': {
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
'Destinations': [
{
'SubnetId': 'string',
'SecurityGroupId': 'string'
},
]
},
],
'Protocol': 'http'|'https',
'Port': 123,
'Path': 'string',
'DeviceIndex': 123,
'IpVersion': 'ipv4'|'ipv6',
'IpScope': 'private',
'Interval': 123,
'Timeout': 123,
'FailureThreshold': 123,
'SuccessThreshold': 123,
'StatusCodeMatcher': 'string',
'InitializationGracePeriodSeconds': 123,
'LastUpdatedAt': datetime(2015, 1, 1),
'TargetTagAssociations': [
{
'Key': 'string',
'Value': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreationTime': datetime(2015, 1, 1),
'ModifyTime': datetime(2015, 1, 1),
'DeletionTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
ApplicationStatusCheck (dict) --
Information about the deleted application status check.
ApplicationStatusCheckId (string) --
The ID of the application status check.
Aggregation (string) --
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status. When set to excluded, the check runs independently and does not affect the instance-level status.
HealthCheckPaths (list) --
The health check paths for the application status check.
(dict) --
Describes a health check path for an application status check.
Source (dict) --
The source for the health check path.
SubnetId (string) --
The ID of the subnet for the source.
SecurityGroupId (string) --
The ID of the security group for the source.
Destinations (list) --
The destinations for the health check path.
(dict) --
Describes a destination for a health check path.
SubnetId (string) --
The ID of the subnet for the destination.
SecurityGroupId (string) --
The ID of the security group for the destination.
Protocol (string) --
The protocol used for the health check.
Port (integer) --
The port used for the health check.
Path (string) --
The URL path used for the health check HTTP request.
DeviceIndex (integer) --
The index of the network device used for the health check. The value is greater than or equal to 0.
IpVersion (string) --
The IP version used for the health check.
IpScope (string) --
The IP scope used for the health check.
Interval (integer) --
The interval, in seconds, between health checks. Valid value: 60.
Timeout (integer) --
The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.
FailureThreshold (integer) --
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
SuccessThreshold (integer) --
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
StatusCodeMatcher (string) --
The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.
InitializationGracePeriodSeconds (integer) --
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
LastUpdatedAt (datetime) --
The date and time when the application status check was last updated.
TargetTagAssociations (list) --
The tags associated with the application status check. Instances with these tags are automatically monitored by this check.
(dict) --
Describes a tag key-value pair for an application status check association.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
Tags (list) --
The tags assigned to the application status check.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
CreationTime (datetime) --
The date and time when the application status check was created.
ModifyTime (datetime) --
The date and time when the application status check was last modified.
DeletionTime (datetime) --
The date and time when the application status check was deleted.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'application-status-check'}}}}
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'application-status-check'}}}}
Response {'LaunchTemplateVersion': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'application-status-check'}}}}}
{'InstanceStatuses': {'ApplicationStatus': {'ImpairedSince': 'timestamp',
'Status': 'ok | impaired | '
'insufficient-data | '
'not-applicable | '
'initializing'}}}
Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.
Instance status includes the following components:
Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshoot instances with failed status checks in the Amazon EC2 User Guide.
Application status checks - Amazon EC2 reports application-level health status for instances, indicating whether applications running on the instance are functioning properly.
Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon EC2 User Guide.
Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon EC2 User Guide.
The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see Eventual consistency in the Amazon EC2 API in the Amazon EC2 Developer Guide.
See also: AWS API Documentation
Request Syntax
client.describe_instance_status(
InstanceIds=[
'string',
],
MaxResults=123,
NextToken='string',
IncludeManagedResources=True|False,
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeAllInstances=True|False
)
list
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
(string) --
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
boolean
Indicates whether to include managed resources in the output. If this parameter is set to true, the output includes resources that are managed by Amazon Web Services services, even if managed resource visibility is set to hidden.
boolean
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
availability-zone - The Availability Zone of the instance.
availability-zone-id - The ID of the Availability Zone of the instance.
event.code - The code for the scheduled event ( instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance ( pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability ( passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
operator.managed - A Boolean that indicates whether this is a managed instance.
operator.principal - The principal that manages the instance. Only valid for managed instances, where managed is true.
system-status.reachability - Filters on system status where the name is reachability ( passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
attached-ebs-status.status - The status of the attached EBS volume for the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
application-status.status - The application status of the instance ( ok | impaired | initializing | insufficient-data | not-applicable).
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
boolean
When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
dict
Response Syntax
{
'InstanceStatuses': [
{
'AvailabilityZone': 'string',
'AvailabilityZoneId': 'string',
'OutpostArn': 'string',
'Operator': {
'Managed': True|False,
'Principal': 'string',
'HiddenByDefault': True|False
},
'Events': [
{
'InstanceEventId': 'string',
'Code': 'instance-reboot'|'system-reboot'|'system-maintenance'|'instance-retirement'|'instance-stop',
'Description': 'string',
'NotAfter': datetime(2015, 1, 1),
'NotBefore': datetime(2015, 1, 1),
'NotBeforeDeadline': datetime(2015, 1, 1)
},
],
'InstanceId': 'string',
'InstanceState': {
'Code': 123,
'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
},
'InstanceStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'SystemStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'AttachedEbsStatus': {
'Details': [
{
'ImpairedSince': datetime(2015, 1, 1),
'Name': 'reachability',
'Status': 'passed'|'failed'|'insufficient-data'|'initializing'
},
],
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing'
},
'ApplicationStatus': {
'Status': 'ok'|'impaired'|'insufficient-data'|'not-applicable'|'initializing',
'ImpairedSince': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstanceStatuses (list) --
Information about the status of the instances.
(dict) --
Describes the status of an instance, including system status, instance status, attached EBS status, and application status.
AvailabilityZone (string) --
The Availability Zone of the instance.
AvailabilityZoneId (string) --
The ID of the Availability Zone of the instance.
OutpostArn (string) --
The Amazon Resource Name (ARN) of the Outpost.
Operator (dict) --
The service provider that manages the instance.
Managed (boolean) --
If true, the resource is managed by a service provider.
Principal (string) --
If managed is true, then the principal is returned. The principal is the service provider that manages the resource.
HiddenByDefault (boolean) --
If true, the resource is hidden by default based on the managed resource visibility settings for the account.
Events (list) --
Any scheduled events associated with the instance.
(dict) --
Describes a scheduled event for an instance.
InstanceEventId (string) --
The ID of the event.
Code (string) --
The event code.
Description (string) --
A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
NotAfter (datetime) --
The latest scheduled end time for the event.
NotBefore (datetime) --
The earliest scheduled start time for the event.
NotBeforeDeadline (datetime) --
The deadline for starting the event.
InstanceId (string) --
The ID of the instance.
InstanceState (dict) --
The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
Code (integer) --
The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
Name (string) --
The current state of the instance.
InstanceStatus (dict) --
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
SystemStatus (dict) --
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
Details (list) --
The system instance health or application instance health.
(dict) --
Describes the instance status.
ImpairedSince (datetime) --
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
Name (string) --
The type of instance status.
Status (string) --
The status.
Status (string) --
The status.
AttachedEbsStatus (dict) --
Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.
Details (list) --
Details about the attached EBS status check for an instance.
(dict) --
Describes the attached EBS status check for an instance.
ImpairedSince (datetime) --
The date and time when the attached EBS status check failed.
Name (string) --
The name of the attached EBS status check.
Status (string) --
The result of the attached EBS status check.
Status (string) --
The current status.
ApplicationStatus (dict) --
Reports impaired functionality that stems from issues with applications running on the instance.
Status (string) --
The current status.
ImpairedSince (datetime) --
The date and time when the application status became impaired.
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
{'LaunchTemplateVersions': {'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'application-status-check'}}}}}
{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'application-status-check'}}},
'TagSpecifications': {'ResourceType': {'application-status-check'}}}}}
{'Tags': {'ResourceType': {'application-status-check'}}}
Describes the specified tags for your EC2 resources.
For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
DryRun=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxResults=123,
NextToken='string'
)
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type. For a list of possible values, see TagSpecification.
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
Name (string) --
The name of the filter. Filter names are case-sensitive.
Values (list) --
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
(string) --
integer
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'NextToken': 'string',
'Tags': [
{
'Key': 'string',
'ResourceId': 'string',
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Value': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags (list) --
The tags.
(dict) --
Describes a tag.
Key (string) --
The tag key.
ResourceId (string) --
The ID of the resource.
ResourceType (string) --
The resource type.
Value (string) --
The tag value.
{'LaunchTemplateData': {'TagSpecifications': {'ResourceType': {'application-status-check'}}}}
{'PoolTagSpecifications': {'ResourceType': {'application-status-check'}}}
Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For the Amazon Web Services GovCloud (US) Regions, authorize only ASN 8987. For the Amazon Web Services European Sovereign Cloud, authorize ASNs 16509 and 214101. For more information, see Bring your own IP addresses (BYOIP) in the Amazon EC2 User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. For more information, see Onboard your address range.
See also: AWS API Documentation
Request Syntax
client.provision_byoip_cidr(
Cidr='string',
CidrAuthorizationContext={
'Message': 'string',
'Signature': 'string'
},
PubliclyAdvertisable=True|False,
Description='string',
DryRun=True|False,
PoolTagSpecifications=[
{
'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'image-usage-report'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'outpost-lag'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'service-link-virtual-interface'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-metering-policy'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'vpc-encryption-control'|'route-server'|'route-server-endpoint'|'route-server-peer'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token'|'capacity-block'|'mac-modification-task'|'ipam-prefix-list-resolver'|'ipam-policy'|'ipam-prefix-list-resolver-target'|'secondary-interface'|'secondary-network'|'secondary-subnet'|'capacity-manager-data-export'|'vpn-concentrator'|'ipam-pool-allocation'|'capacity-reservation-cancellation-quote'|'application-status-check',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
MultiRegion=True|False,
NetworkBorderGroup='string'
)
string
[REQUIRED]
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
dict
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
Message (string) -- [REQUIRED]
The plain-text authorization message for the prefix and account.
Signature (string) -- [REQUIRED]
The signed authorization message for the prefix and account.
boolean
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
string
A description for the address range and the address pool.
boolean
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
list
The tags to apply to the address pool.
(dict) --
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
ResourceType (string) --
The type of resource to tag on creation.
Tags (list) --
The tags to apply to the resource.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
Value (string) --
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
boolean
Reserved.
string
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
dict
Response Syntax
{
'ByoipCidr': {
'Cidr': 'string',
'Description': 'string',
'AsnAssociations': [
{
'Asn': 'string',
'Cidr': 'string',
'StatusMessage': 'string',
'State': 'disassociated'|'failed-disassociation'|'failed-association'|'pending-disassociation'|'pending-association'|'associated'
},
],
'StatusMessage': 'string',
'State': 'advertised'|'deprovisioned'|'failed-deprovision'|'failed-provision'|'pending-advertising'|'pending-deprovision'|'pending-provision'|'pending-withdrawal'|'provisioned'|'provisioned-not-publicly-advertisable',
'NetworkBorderGroup': 'string',
'AdvertisementType': 'string'
}
}
Response Structure
(dict) --
ByoipCidr (dict) --
Information about the address range.
Cidr (string) --
The address range, in CIDR notation.
Description (string) --
The description of the address range.
AsnAssociations (list) --
The BYOIP CIDR associations with ASNs.
(dict) --
An Autonomous System Number (ASN) and BYOIP CIDR association.
Asn (string) --
The association's ASN.
Cidr (string) --
The association's CIDR.
StatusMessage (string) --
The association's status message.
State (string) --
The association's state.
StatusMessage (string) --
Upon success, contains the ID of the address pool. Otherwise, contains an error message.
State (string) --
The state of the address range.
advertised: The address range is being advertised to the internet by Amazon Web Services.
deprovisioned: The address range is deprovisioned.
failed-deprovision: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
failed-provision: The request to provision the address range was unsuccessful.
pending-deprovision: You’ve submitted a request to deprovision an address range and it's pending.
pending-provision: You’ve submitted a request to provision an address range and it's pending.
provisioned: The address range is provisioned and can be advertised. The range is not currently advertised.
provisioned-not-publicly-advertisable: The address range is provisioned and cannot be advertised.
NetworkBorderGroup (string) --
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
us-east-1-dfw-2
us-west-2-lax-1
us-west-2-phx-2
AdvertisementType (string) --
Specifies the advertisement method for the BYOIP CIDR. Valid values are:
unicast: IP is advertised from a single location (regional services like EC2)
anycast: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see Bring your own IP to CloudFront using IPAM in the Amazon VPC IPAM User Guide.
{'SpotFleetRequestConfig': {'LaunchSpecifications': {'TagSpecifications': {'ResourceType': {'application-status-check'}}},
'TagSpecifications': {'ResourceType': {'application-status-check'}}}}