OpsWorks / Client / register_elastic_ip

register_elastic_ip#

OpsWorks.Client.register_elastic_ip(**kwargs)#

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

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

See also: AWS API Documentation

Request Syntax

response = client.register_elastic_ip(
    ElasticIp='string',
    StackId='string'
)
Parameters:

  • ElasticIp (string) –

    [REQUIRED]

    The Elastic IP address.

  • StackId (string) –

    [REQUIRED]

    The stack ID.

Return type:

dict

Returns:

Response Syntax

{
    'ElasticIp': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a RegisterElasticIp request.

    • ElasticIp (string) –

      The Elastic IP address.

Exceptions

  • OpsWorks.Client.exceptions.ValidationException

  • OpsWorks.Client.exceptions.ResourceNotFoundException