[ aws . ec2 ]

describe-network-interface-permissions

Description

Describes the permissions for your network interfaces.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-network-interface-permissions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: NetworkInterfacePermissions

Synopsis

  describe-network-interface-permissions
[--network-interface-permission-ids <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--network-interface-permission-ids (list)

One or more network interface permission IDs.

(string)

Syntax:

"string" "string" ...

--filters (list)

One or more filters.

• network-interface-permission.network-interface-permission-id - The ID of the permission.

• network-interface-permission.network-interface-id - The ID of the network interface.

• network-interface-permission.aws-account-id - The AWS account ID.

• network-interface-permission.aws-service - The AWS service.

• network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE ).

(structure)

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

• DescribeAvailabilityZones

• DescribeImages

• DescribeInstances

• DescribeKeyPairs

• DescribeSecurityGroups

• DescribeSnapshots

• DescribeSubnets

• DescribeTags

• DescribeVolumes

• DescribeVpcs

Name -> (string)

The name of the filter. Filter names are case-sensitive.

Values -> (list)

The filter values. Filter values are case-sensitive.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To describe your network interface permissions

This example describes all of your network interface permissions.

Command:

aws ec2 describe-network-interface-permissions

Output:

{
  "NetworkInterfacePermissions": [
      {
          "PermissionState": {
              "State": "GRANTED"
          },
          "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea",
          "NetworkInterfaceId": "eni-b909511a",
          "Permission": "INSTANCE-ATTACH",
          "AwsAccountId": "123456789012"
      }
  ]
}

Output

NetworkInterfacePermissions -> (list)

The network interface permissions.

(structure)

Describes a permission for a network interface.

NetworkInterfacePermissionId -> (string)

The ID of the network interface permission.

NetworkInterfaceId -> (string)

The ID of the network interface.

AwsAccountId -> (string)

The AWS account ID.

AwsService -> (string)

The AWS service.

Permission -> (string)

The type of permission.

PermissionState -> (structure)

Information about the state of the permission.

State -> (string)

The state of the permission.

StatusMessage -> (string)

A status message, if applicable.

NextToken -> (string)

The token to use to retrieve the next page of results.