ServiceResource / Collection / instances

instances#

EC2.ServiceResource.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 = ec2.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 = ec2.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 = ec2.instances.filter(
    InstanceIds=[
        'string',
    ],
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    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.

  • Filters (list) –

    The filters.

    • affinity - The affinity setting for an instance running on a Dedicated Host ( default | host).

    • architecture - The instance architecture ( i386 | x86_64 | arm64).

    • availability-zone - The Availability Zone of the instance.

    • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2022-09-15T17:15:20.000Z.

    • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

    • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

    • block-device-mapping.status - The status for the EBS volume ( attaching | attached | detaching | detached).

    • block-device-mapping.volume-id - The volume ID of the EBS volume.

    • boot-mode - The boot mode that was specified by the AMI ( legacy-bios | uefi | uefi-preferred).

    • capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.

    • capacity-reservation-specification.capacity-reservation-preference - The instance’s Capacity Reservation preference ( open | none).

    • capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of the targeted Capacity Reservation.

    • capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn - The ARN of the targeted Capacity Reservation group.

    • client-token - The idempotency token you provided when you launched the instance.

    • current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start ( legacy-bios | uefi).

    • dns-name - The public DNS name of the instance.

    • ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.

    • ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA.

    • enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

    • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

    • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

    • hypervisor - The hypervisor type of the instance ( ovm | xen). The value xen is used for both Xen and Nitro hypervisors.

    • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

    • iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.

    • image-id - The ID of the image used to launch the instance.

    • instance-id - The ID of the instance.

    • instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block ( spot | scheduled | capacity-block).

    • instance-state-code - The state of the instance, 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-type - The type of instance (for example, t2.micro).

    • instance.group-id - The ID of the security group for the instance.

    • instance.group-name - The name of the security group for the instance.

    • ip-address - The public IPv4 address of the instance.

    • ipv6-address - The IPv6 address of the instance.

    • kernel-id - The kernel ID.

    • key-name - The name of the key pair used when the instance was launched.

    • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

    • launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2021-09-29T*, which matches an entire day.

    • maintenance-options.auto-recovery - The current automatic recovery behavior of the instance ( disabled | default).

    • metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance ( enabled | disabled)

    • metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled ( disabled | enabled).

    • metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled ( disabled | enabled).

    • metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)

    • metadata-options.http-tokens - The metadata request authorization state ( optional | required)

    • metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata ( enabled | disabled)

    • metadata-options.state - The state of the metadata option changes ( pending | applied).

    • monitoring-state - Indicates whether detailed monitoring is enabled ( disabled | enabled).

    • network-interface.addresses.association.allocation-id - The allocation ID.

    • network-interface.addresses.association.association-id - The association ID.

    • network-interface.addresses.association.carrier-ip - The carrier IP address.

    • network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.

    • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

    • network-interface.addresses.association.public-dns-name - The public DNS name.

    • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

    • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

    • network-interface.addresses.private-dns-name - The private DNS name.

    • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

    • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

    • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

    • network-interface.association.carrier-ip - The customer-owned IP address.

    • network-interface.association.customer-owned-ip - The customer-owned IP address.

    • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

    • network-interface.association.public-dns-name - The public DNS name.

    • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

    • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

    • network-interface.attachment.attachment-id - The ID of the interface attachment.

    • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

    • network-interface.attachment.device-index - The device index to which the network interface is attached.

    • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

    • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

    • network-interface.attachment.network-card-index - The index of the network card.

    • network-interface.attachment.status - The status of the attachment ( attaching | attached | detaching | detached).

    • network-interface.availability-zone - The Availability Zone for the network interface.

    • network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet.

    • network-interface.description - The description of the network interface.

    • network-interface.group-id - The ID of a security group associated with the network interface.

    • network-interface.group-name - The name of a security group associated with the network interface.

    • network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network interface.

    • network-interface.ipv6-address - The IPv6 address associated with the network interface.

    • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

    • network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the primary IPv6 address.

    • network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network interface.

    • network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.

    • network-interface.mac-address - The MAC address of the network interface.

    • network-interface.network-interface-id - The ID of the network interface.

    • network-interface.outpost-arn - The ARN of the Outpost.

    • network-interface.owner-id - The ID of the owner of the network interface.

    • network-interface.private-dns-name - The private DNS name of the network interface.

    • network-interface.private-ip-address - The private IPv4 address.

    • network-interface.public-dns-name - The public DNS name.

    • network-interface.requester-id - The requester ID for the network interface.

    • network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.

    • network-interface.status - The status of the network interface ( available) | in-use).

    • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

    • network-interface.subnet-id - The ID of the subnet for the network interface.

    • network-interface.tag-key - The key of a tag assigned to the network interface.

    • network-interface.tag-value - The value of a tag assigned to the network interface.

    • network-interface.vpc-id - The ID of the VPC for the network interface.

    • outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

    • owner-id - The Amazon Web Services account ID of the instance owner.

    • placement-group-name - The name of the placement group for the instance.

    • placement-partition-number - The partition in which the instance is located.

    • platform - The platform. To list only Windows instances, use windows.

    • platform-details - The platform ( Linux/UNIX | Red Hat BYOL Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Red Hat Enterprise Linux with SQL Server Standard and HA | Red Hat Enterprise Linux with SQL Server Enterprise and HA | Red Hat Enterprise Linux with SQL Server Standard | Red Hat Enterprise Linux with SQL Server Web | Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise | SQL Server Standard | SQL Server Web | SUSE Linux | Ubuntu Pro | Windows | Windows BYOL | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web).

    • private-dns-name - The private IPv4 DNS name of the instance.

    • private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records.

    • private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

    • private-dns-name-options.hostname-type - The type of hostname ( ip-name | resource-name).

    • private-ip-address - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter network-interface.addresses.private-ip-address.

    • product-code - The product code associated with the AMI used to launch the instance.

    • product-code.type - The type of product code ( devpay | marketplace).

    • ramdisk-id - The RAM disk ID.

    • reason - The reason for the current state of the instance (for example, shows “User Initiated [date]” when you stop or terminate the instance). Similar to the state-reason-code filter.

    • requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).

    • reservation-id - The ID of the instance’s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

    • root-device-name - The device name of the root device volume (for example, /dev/sda1).

    • root-device-type - The type of the root device volume ( ebs | instance-store).

    • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

    • spot-instance-request-id - The ID of the Spot Instance request.

    • state-reason-code - The reason code for the state change.

    • state-reason-message - A message that describes the state change.

    • subnet-id - The ID of the subnet for the instance.

    • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    • tenancy - The tenancy of an instance ( dedicated | default | host).

    • tpm-support - Indicates if the instance is configured for NitroTPM support ( v2.0).

    • usage-operation - The usage operation value for the instance ( RunInstances | RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 | RunInstances:1014 | RunInstances:1110 | RunInstances:0014 | RunInstances:0210 | RunInstances:0110 | RunInstances:0100 | RunInstances:0004 | RunInstances:0200 | RunInstances:000g | RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 | RunInstances:0102 | RunInstances:0006 | RunInstances:0202).

    • usage-operation-update-time - The time that the usage operation was last updated, for example, 2022-09-15T17:15:20.000Z.

    • virtualization-type - The virtualization type of the instance ( paravirtual | hvm).

    • vpc-id - The ID of the VPC that the instance is running in.

    • (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) –

  • 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 = ec2.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 = ec2.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 = ec2.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 = ec2.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 = ec2.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 = ec2.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 = ec2.instances.terminate(
    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

{
    '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 = ec2.instances.unmonitor(
    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.