OpsWorks / Client / describe_instances

describe_instances

OpsWorks.Client.describe_instances(**kwargs)

Requests a description of a set of instances.

Note

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_instances(
    StackId='string',
    LayerId='string',
    InstanceIds=[
        'string',
    ]
)

Parameters:

• StackId (string) – A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

• LayerId (string) – A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

• InstanceIds (list) –

  An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Instances': [
        {
            'AgentVersion': 'string',
            'AmiId': 'string',
            'Architecture': 'x86_64'|'i386',
            'Arn': 'string',
            'AutoScalingType': 'load'|'timer',
            'AvailabilityZone': 'string',
            'BlockDeviceMappings': [
                {
                    'DeviceName': 'string',
                    'NoDevice': 'string',
                    'VirtualName': 'string',
                    'Ebs': {
                        'SnapshotId': 'string',
                        'Iops': 123,
                        'VolumeSize': 123,
                        'VolumeType': 'gp2'|'io1'|'standard',
                        'DeleteOnTermination': True|False
                    }
                },
            ],
            'CreatedAt': 'string',
            'EbsOptimized': True|False,
            'Ec2InstanceId': 'string',
            'EcsClusterArn': 'string',
            'EcsContainerInstanceArn': 'string',
            'ElasticIp': 'string',
            'Hostname': 'string',
            'InfrastructureClass': 'string',
            'InstallUpdatesOnBoot': True|False,
            'InstanceId': 'string',
            'InstanceProfileArn': 'string',
            'InstanceType': 'string',
            'LastServiceErrorId': 'string',
            'LayerIds': [
                'string',
            ],
            'Os': 'string',
            'Platform': 'string',
            'PrivateDns': 'string',
            'PrivateIp': 'string',
            'PublicDns': 'string',
            'PublicIp': 'string',
            'RegisteredBy': 'string',
            'ReportedAgentVersion': 'string',
            'ReportedOs': {
                'Family': 'string',
                'Name': 'string',
                'Version': 'string'
            },
            'RootDeviceType': 'ebs'|'instance-store',
            'RootDeviceVolumeId': 'string',
            'SecurityGroupIds': [
                'string',
            ],
            'SshHostDsaKeyFingerprint': 'string',
            'SshHostRsaKeyFingerprint': 'string',
            'SshKeyName': 'string',
            'StackId': 'string',
            'Status': 'string',
            'SubnetId': 'string',
            'Tenancy': 'string',
            'VirtualizationType': 'paravirtual'|'hvm'
        },
    ]
}

Response Structure

• (dict) –

  Contains the response to a DescribeInstances request.

  • Instances (list) –

    An array of Instance objects that describe the instances.

    • (dict) –

      Describes an instance.

      • AgentVersion (string) –

        The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.

      • AmiId (string) –

        A custom AMI ID to be used to create the instance. For more information, see Instances

      • Architecture (string) –

        The instance architecture: “i386” or “x86_64”.

      • Arn (string) –

        The instance’s Amazon Resource Number (ARN).

      • AutoScalingType (string) –

        For load-based or time-based instances, the type.

      • AvailabilityZone (string) –

        The instance Availability Zone. For more information, see Regions and Endpoints.

      • BlockDeviceMappings (list) –

        An array of BlockDeviceMapping objects that specify the instance’s block device mappings.

        • (dict) –

          Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

          • DeviceName (string) –

            The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and OpsWorks Stacks will provide the correct device name.

          • NoDevice (string) –

            Suppresses the specified device included in the AMI’s block device mapping.

          • VirtualName (string) –

            The virtual device name. For more information, see BlockDeviceMapping.

          • Ebs (dict) –

            An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

            • SnapshotId (string) –

              The snapshot ID.

            • Iops (integer) –

              The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

            • VolumeSize (integer) –

              The volume size, in GiB. For more information, see EbsBlockDevice.

            • VolumeType (string) –

              The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

              If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. Amazon Web Services uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

            • DeleteOnTermination (boolean) –

              Whether the volume is deleted on instance termination.

      • CreatedAt (string) –

        The time that the instance was created.

      • EbsOptimized (boolean) –

        Whether this is an Amazon EBS-optimized instance.

      • Ec2InstanceId (string) –

        The ID of the associated Amazon EC2 instance.

      • EcsClusterArn (string) –

        For container instances, the Amazon ECS cluster’s ARN.

      • EcsContainerInstanceArn (string) –

        For container instances, the instance’s ARN.

      • ElasticIp (string) –

        The instance Elastic IP address.

      • Hostname (string) –

        The instance host name. The following are character limits for instance host names.

        • Linux-based instances: 63 characters

        • Windows-based instances: 15 characters

      • InfrastructureClass (string) –

        For registered instances, the infrastructure class: ec2 or on-premises.

      • InstallUpdatesOnBoot (boolean) –

        Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must update instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

        Note

        We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

      • InstanceId (string) –

        The instance ID.

      • InstanceProfileArn (string) –

        The ARN of the instance’s IAM profile. For more information about IAM ARNs, see Using Identifiers.

      • InstanceType (string) –

        The instance type, such as t2.micro.

      • LastServiceErrorId (string) –

        The ID of the last service error. For more information, call DescribeServiceErrors.

      • LayerIds (list) –

        An array containing the instance layer IDs.

        • (string) –

      • Os (string) –

        The instance’s operating system.

      • Platform (string) –

        The instance’s platform.

      • PrivateDns (string) –

        The instance’s private DNS name.

      • PrivateIp (string) –

        The instance’s private IP address.

      • PublicDns (string) –

        The instance public DNS name.

      • PublicIp (string) –

        The instance public IP address.

      • RegisteredBy (string) –

        For registered instances, who performed the registration.

      • ReportedAgentVersion (string) –

        The instance’s reported OpsWorks Stacks agent version.

      • ReportedOs (dict) –

        For registered instances, the reported operating system.

        • Family (string) –

          The operating system family.

        • Name (string) –

          The operating system name.

        • Version (string) –

          The operating system version.

      • RootDeviceType (string) –

        The instance’s root device type. For more information, see Storage for the Root Device.

      • RootDeviceVolumeId (string) –

        The root device volume ID.

      • SecurityGroupIds (list) –

        An array containing the instance security group IDs.

        • (string) –

      • SshHostDsaKeyFingerprint (string) –

        The SSH key’s Deep Security Agent (DSA) fingerprint.

      • SshHostRsaKeyFingerprint (string) –

        The SSH key’s RSA fingerprint.

      • SshKeyName (string) –

        The instance’s Amazon EC2 key-pair name.

      • StackId (string) –

        The stack ID.

      • Status (string) –

        The instance status:

        • booting

        • connection_lost

        • online

        • pending

        • rebooting

        • requested

        • running_setup

        • setup_failed

        • shutting_down

        • start_failed

        • stop_failed

        • stopped

        • stopping

        • terminated

        • terminating

      • SubnetId (string) –

        The instance’s subnet ID; applicable only if the stack is running in a VPC.

      • Tenancy (string) –

        The instance’s tenancy option, such as dedicated or host.

      • VirtualizationType (string) –

        The instance’s virtualization type: paravirtual or hvm.

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException