Amazon Elastic MapReduce

{'InstanceStates': ['AWAITING_FULFILLMENT | PROVISIONING | BOOTSTRAPPING | '
                    'RUNNING | TERMINATED']}

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. For example, this operation indicates when the EC2 instances reach the Ready state, when instances become available to Amazon EMR to use for jobs, and the IP addresses for cluster instances, etc.

Request Syntax

client.list_instances(
    ClusterId='string',
    InstanceGroupId='string',
    InstanceGroupTypes=[
        'MASTER'|'CORE'|'TASK',
    ],
    InstanceStates=[
        'AWAITING_FULFILLMENT'|'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'TERMINATED',
    ],
    Marker='string'
)

type ClusterId:

string

param ClusterId:

[REQUIRED]

The identifier of the cluster for which to list the instances.

type InstanceGroupId:

string

param InstanceGroupId:

The identifier of the instance group for which to list the instances.

type InstanceGroupTypes:

list

param InstanceGroupTypes:

The type of instance group for which to list the instances.

• (string) --

type InstanceStates:

list

param InstanceStates:

A list of instance states that will filter the instances returned with this request.

• (string) --

type Marker:

string

param Marker:

The pagination token that indicates the next set of results to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'Instances': [
        {
            'Id': 'string',
            'Ec2InstanceId': 'string',
            'PublicDnsName': 'string',
            'PublicIpAddress': 'string',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'Status': {
                'State': 'AWAITING_FULFILLMENT'|'PROVISIONING'|'BOOTSTRAPPING'|'RUNNING'|'TERMINATED',
                'StateChangeReason': {
                    'Code': 'INTERNAL_ERROR'|'VALIDATION_ERROR'|'INSTANCE_FAILURE'|'BOOTSTRAP_FAILURE'|'CLUSTER_TERMINATED',
                    'Message': 'string'
                },
                'Timeline': {
                    'CreationDateTime': datetime(2015, 1, 1),
                    'ReadyDateTime': datetime(2015, 1, 1),
                    'EndDateTime': datetime(2015, 1, 1)
                }
            },
            'InstanceGroupId': 'string',
            'EbsVolumes': [
                {
                    'Device': 'string',
                    'VolumeId': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  This output contains the list of instances.

  • Instances (list) --

    The list of instances for the cluster and given filters.

    • (dict) --

      Represents an EC2 instance provisioned as part of cluster.

      • Id (string) --

        The unique identifier for the instance in Amazon EMR.

      • Ec2InstanceId (string) --

        The unique identifier of the instance in Amazon EC2.

      • PublicDnsName (string) --

        The public DNS name of the instance.

      • PublicIpAddress (string) --

        The public IP address of the instance.

      • PrivateDnsName (string) --

        The private DNS name of the instance.

      • PrivateIpAddress (string) --

        The private IP address of the instance.

      • Status (dict) --

        The current status of the instance.

        • State (string) --

          The current state of the instance.

        • StateChangeReason (dict) --

          The details of the status change reason for the instance.

          • Code (string) --

            The programmable code for the state change reason.

          • Message (string) --

            The status change reason description.

        • Timeline (dict) --

          The timeline of the instance status over time.

          • CreationDateTime (datetime) --

            The creation date and time of the instance.

          • ReadyDateTime (datetime) --

            The date and time when the instance was ready to perform tasks.

          • EndDateTime (datetime) --

            The date and time when the instance was terminated.

      • InstanceGroupId (string) --

        The identifier of the instance group to which this instance belongs.

      • EbsVolumes (list) --

        The list of EBS volumes that are attached to this instance.

        • (dict) --

          EBS block device that's attached to an EC2 instance.

          • Device (string) --

            The device name that is exposed to the instance, such as /dev/sdh.

          • VolumeId (string) --

            The volume identifier of the EBS volume.

  • Marker (string) --

    The pagination token that indicates the next set of results to retrieve.