Vpc / Collection / instances

instances#

EC2.Vpc.instances#

A collection of Instance resources.A Instance Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

all()#

Creates an iterable of all Instance resources in the collection.

See also: AWS API Documentation

Request Syntax

instance_iterator = vpc.instances.all()

Return type:: list(ec2.Instance)
Returns:: A list of Instance resources

create_tags(**kwargs)#

Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users’ access to resources based on tags, see Supported resource-level permissions for Amazon EC2 API actions in the Amazon Elastic Compute Cloud User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.create_tags(
    DryRun=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': '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.
Tags (list) –
[REQUIRED]

The tags. The value parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.
- (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.

Returns:

None

filter(**kwargs)#

Creates an iterable of all Instance resources in the collection filtered by kwargs passed to method. A Instance collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

See also: AWS API Documentation

Request Syntax

instance_iterator = vpc.instances.filter(
    InstanceIds=[
        'string',
    ],
    DryRun=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters:

InstanceIds (list) –
The instance IDs.

Default: Describes all your instances.
- (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.
NextToken (string) – The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults (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.

Return type:

list(ec2.Instance)

Returns:

A list of Instance resources

limit(**kwargs)#

Creates an iterable up to a specified amount of Instance resources in the collection.

See also: AWS API Documentation

Request Syntax

instance_iterator = vpc.instances.limit(
    count=123
)

Parameters:: count (integer) – The limit to the number of resources in the iterable.
Return type:: list(ec2.Instance)
Returns:: A list of Instance resources

monitor(**kwargs)#

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitor your instances using CloudWatch in the Amazon EC2 User Guide.

To disable detailed monitoring, see UnmonitorInstances.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.monitor(
    DryRun=True|False
)

Parameters:

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.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceMonitorings': [
        {
            'InstanceId': 'string',
            'Monitoring': {
                'State': 'disabled'|'disabling'|'enabled'|'pending'
            }
        },
    ]
}

Response Structure

(dict) –
- InstanceMonitorings (list) –
  
  The monitoring information.
  - (dict) –
    
    Describes the monitoring of an instance.
    - InstanceId (string) –
      
      The ID of the instance.
    - Monitoring (dict) –
      
      The monitoring for the instance.
      - State (string) –
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

page_size(**kwargs)#

Creates an iterable of all Instance resources in the collection, but limits the number of items returned by each service call by the specified amount.

See also: AWS API Documentation

Request Syntax

instance_iterator = vpc.instances.page_size(
    count=123
)

Parameters:: count (integer) – The number of items returned by each service call
Return type:: list(ec2.Instance)
Returns:: A list of Instance resources

reboot(**kwargs)#

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Troubleshoot an unreachable instance in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.reboot(
    DryRun=True|False
)

Parameters:: 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.
Returns:: None

start(**kwargs)#

Starts an Amazon EBS-backed instance that you’ve previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with host tenancy and the unlimited CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.

For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.start(
    AdditionalInfo='string',
    DryRun=True|False
)

Parameters:

AdditionalInfo (string) – Reserved.
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.

Return type:

dict

Returns:

Response Syntax

{
    'StartingInstances': [
        {
            'InstanceId': 'string',
            'CurrentState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            },
            'PreviousState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            }
        },
    ]
}

Response Structure

(dict) –
- StartingInstances (list) –
  
  Information about the started instances.
  - (dict) –
    
    Describes an instance state change.
    - InstanceId (string) –
      
      The ID of the instance.
    - CurrentState (dict) –
      
      The current state of the instance.
      - 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.
    - PreviousState (dict) –
      
      The previous state of the instance.
      - 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.

stop(**kwargs)#

Stops an Amazon EBS-backed instance. For more information, see Stop and start Amazon EC2 instances in the Amazon EC2 User Guide.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.

We don’t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can’t stop or hibernate instance store-backed instances. You can’t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.stop(
    Hibernate=True|False,
    DryRun=True|False,
    Force=True|False
)

Parameters:

Hibernate (boolean) –
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.

Default: false
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.
Force (boolean) –
Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

Return type:

dict

Returns:

Response Syntax

{
    'StoppingInstances': [
        {
            'InstanceId': 'string',
            'CurrentState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            },
            'PreviousState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            }
        },
    ]
}

Response Structure

(dict) –
- StoppingInstances (list) –
  
  Information about the stopped instances.
  - (dict) –
    
    Describes an instance state change.
    - InstanceId (string) –
      
      The ID of the instance.
    - CurrentState (dict) –
      
      The current state of the instance.
      - 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.
    - PreviousState (dict) –
      
      The previous state of the instance.
      - 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.

terminate(**kwargs)#

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:

The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.

For example, say you have the following instances:

Instance A: us-east-1a; Not protected
Instance B: us-east-1a; Not protected
Instance C: us-east-1b; Protected
Instance D: us-east-1b; not protected

If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:

Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b (Instance C) is enabled for termination protection.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.terminate(
    DryRun=True|False
)

Parameters:

Return type:

dict

Returns:

Response Syntax

{
    'TerminatingInstances': [
        {
            'InstanceId': 'string',
            'CurrentState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            },
            'PreviousState': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            }
        },
    ]
}

Response Structure

(dict) –
- TerminatingInstances (list) –
  
  Information about the terminated instances.
  - (dict) –
    
    Describes an instance state change.
    - InstanceId (string) –
      
      The ID of the instance.
    - CurrentState (dict) –
      
      The current state of the instance.
      - 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.
    - PreviousState (dict) –
      
      The previous state of the instance.
      - 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.

unmonitor(**kwargs)#

Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = vpc.instances.unmonitor(
    DryRun=True|False
)

Parameters:

Return type:

dict

Returns:

Response Syntax

{
    'InstanceMonitorings': [
        {
            'InstanceId': 'string',
            'Monitoring': {
                'State': 'disabled'|'disabling'|'enabled'|'pending'
            }
        },
    ]
}

Response Structure

(dict) –
- InstanceMonitorings (list) –
  
  The monitoring information.
  - (dict) –
    
    Describes the monitoring of an instance.
    - InstanceId (string) –
      
      The ID of the instance.
    - Monitoring (dict) –
      
      The monitoring for the instance.
      - State (string) –
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.