ec2_describe_security_groups {aws.ecx}R Documentation

Describe Security Groups

Description

Describe Security Groups

Usage

ec2_describe_security_groups(
  Filter = NULL,
  GroupId = NULL,
  GroupName = NULL,
  DryRun = NULL,
  NextToken = NULL,
  MaxResults = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

GroupId

List. The IDs of the security groups.[optional]

GroupName

List. [EC2-Classic and default VPC only] The names of the security groups.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

NextToken

Characters. The token for the next page of results[optional]

MaxResults

Integer. The maximum number of results to return in a single call.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

Filter

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

GroupId

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

GroupName

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

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.

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.


[Package aws.ecx version 1.0.5 Index]