OpsWorks / Client / describe_elastic_ips

describe_elastic_ips

OpsWorks.Client.describe_elastic_ips(**kwargs)

Describes Elastic IP addresses.

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_elastic_ips(
    InstanceId='string',
    StackId='string',
    Ips=[
        'string',
    ]
)

Parameters:

• InstanceId (string) – The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

• StackId (string) – A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

• Ips (list) –

  An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ElasticIps': [
        {
            'Ip': 'string',
            'Name': 'string',
            'Domain': 'string',
            'Region': 'string',
            'InstanceId': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Contains the response to a DescribeElasticIps request.

  • ElasticIps (list) –

    An ElasticIps object that describes the specified Elastic IP addresses.

    • (dict) –

      Describes an Elastic IP address.

      • Ip (string) –

        The IP address.

      • Name (string) –

        The name.

      • Domain (string) –

        The domain.

      • Region (string) –

        The AWS region. For more information, see Regions and Endpoints.

      • InstanceId (string) –

        The ID of the instance that the address is attached to.

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException