EC2 / Paginator / DescribeSpotFleetInstances

DescribeSpotFleetInstances#

class EC2.Paginator.DescribeSpotFleetInstances#

paginator = client.get_paginator('describe_spot_fleet_instances')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    DryRun=True|False,
    SpotFleetRequestId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

DryRun (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.
SpotFleetRequestId (string) –
[REQUIRED]

The ID of the Spot Fleet request.
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

{
    'ActiveInstances': [
        {
            'InstanceId': 'string',
            'InstanceType': 'string',
            'SpotInstanceRequestId': 'string',
            'InstanceHealth': 'healthy'|'unhealthy'
        },
    ],
    'SpotFleetRequestId': 'string'
}

Response Structure

(dict) –

Contains the output of DescribeSpotFleetInstances.
- ActiveInstances (list) –
  
  The running instances. This list is refreshed periodically and might be out of date.
  - (dict) –
    
    Describes a running instance in a Spot Fleet.
    - InstanceId (string) –
      
      The ID of the instance.
    - InstanceType (string) –
      
      The instance type.
    - SpotInstanceRequestId (string) –
      
      The ID of the Spot Instance request.
    - InstanceHealth (string) –
      
      The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.
- SpotFleetRequestId (string) –
  
  The ID of the Spot Fleet request.