Skip to content

Describe Secondary Networks

ec2_describe_secondary_networks R Documentation

Describes one or more secondary networks

Description

Describes one or more secondary networks.

Usage

ec2_describe_secondary_networks(DryRun, Filters, MaxResults, NextToken,
  SecondaryNetworkIds)

Arguments

DryRun

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.

Filters

The filters. The following are the possible values:

  • ipv4-cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.cidr-block - An IPv4 CIDR block associated with the secondary network.

  • ipv4-cidr-block-association.state - The state of an IPv4 CIDR block associated with the secondary network.

  • owner-id - The ID of the Amazon Web Services account that owns the secondary network.

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

  • secondary-network-arn - The ARN of the secondary network.

  • state - The state of the secondary network (⁠create-in-progress⁠ | create-complete | create-failed | ⁠delete-in-progress⁠ | delete-complete | delete-failed).

  • 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 assigned a tag with a specific key, regardless of the tag value.

  • type - The type of the secondary network (rdma).

MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

NextToken

The token for the next page of results.

SecondaryNetworkIds

The IDs of the secondary networks.

Value

A list with the following syntax:

list(
  SecondaryNetworks = list(
    list(
      SecondaryNetworkId = "string",
      SecondaryNetworkArn = "string",
      OwnerId = "string",
      Type = "rdma",
      State = "create-in-progress"|"create-complete"|"create-failed"|"delete-in-progress"|"delete-complete"|"delete-failed",
      StateReason = "string",
      Ipv4CidrBlockAssociations = list(
        list(
          AssociationId = "string",
          CidrBlock = "string",
          State = "associating"|"associated"|"association-failed"|"disassociating"|"disassociated"|"disassociation-failed",
          StateReason = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_secondary_networks(
  DryRun = TRUE|FALSE,
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  SecondaryNetworkIds = list(
    "string"
  )
)