EC2 / Paginator / DescribeInstanceStatus

DescribeInstanceStatus#

class EC2.Paginator.DescribeInstanceStatus#

paginator = client.get_paginator('describe_instance_status')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EC2.Client.describe_instance_status().

Request Syntax

response_iterator = paginator.paginate(
    InstanceIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    IncludeAllInstances=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

InstanceIds (list) –
The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.
- (string) –
DryRun (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.
Filters (list) –
The filters.
- availability-zone - 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).
- 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).
- (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.
  - 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) –
IncludeAllInstances (boolean) –
When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceStatuses': [
        {
            'AvailabilityZone': 'string',
            'OutpostArn': 'string',
            'Operator': {
                'Managed': True|False,
                'Principal': 'string'
            },
            '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'
            }
        },
    ],

}

Response Structure

(dict) –
- InstanceStatuses (list) –
  
  Information about the status of the instances.
  - (dict) –
    
    Describes the status of an instance.
    - AvailabilityZone (string) –
      
      The Availability Zone of the instance.
    - OutpostArn (string) –
      
      The Amazon Resource Name (ARN) of the Outpost.
    - Operator (dict) –
      
      The entity that manages the instance.
      - Managed (boolean) –
        
        If true, the resource is managed by an entity.
      - Principal (string) –
        
        If managed is true, then the principal is returned. The principal is the entity that manages the resource.
    - 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.