opsworks_describe_elastic_ips: Describes Elastic IP addresses

Description Usage Arguments Value Request syntax

View source: R/opsworks_operations.R

Description

Describes Elastic IP addresses.

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.

Usage

1
opsworks_describe_elastic_ips(InstanceId, StackId, Ips)

Arguments

InstanceId

The instance ID. If you include this parameter, describe_elastic_ips returns a description of the Elastic IP addresses associated with the specified instance.

StackId

A stack ID. If you include this parameter, describe_elastic_ips returns a description of the Elastic IP addresses that are registered with the specified stack.

Ips

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
list(
  ElasticIps = list(
    list(
      Ip = "string",
      Name = "string",
      Domain = "string",
      Region = "string",
      InstanceId = "string"
    )
  )
)

Request syntax

1
2
3
4
5
6
7
svc$describe_elastic_ips(
  InstanceId = "string",
  StackId = "string",
  Ips = list(
    "string"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.