AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . network-firewall ]

describe-proxy

Description

Returns the data objects for the specified proxy.

See also: AWS API Documentation

Synopsis

  describe-proxy
[--proxy-name <value>]
[--proxy-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--proxy-name (string)

The descriptive name of the proxy. You can’t change the name of a proxy after you create it.

You must specify the ARN or the name, and you can specify both.

--proxy-arn (string)

The Amazon Resource Name (ARN) of a proxy.

You must specify the ARN or the name, and you can specify both.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

Proxy -> (structure)

Proxy attached to a NAT gateway.

ProxyName -> (string)

The descriptive name of the proxy. You can’t change the name of a proxy after you create it.

ProxyArn -> (string)

The Amazon Resource Name (ARN) of a proxy.

ProxyConfigurationName -> (string)

The descriptive name of the proxy configuration. You can’t change the name of a proxy configuration after you create it.

ProxyConfigurationArn -> (string)

The Amazon Resource Name (ARN) of a proxy configuration.

NatGatewayId -> (string)

The NAT Gateway for the proxy.

ProxyState -> (string)

Current attachment/detachment status of the Proxy.

ProxyModifyState -> (string)

Current modification status of the Proxy.

ListenerProperties -> (list)

Listener properties for HTTP and HTTPS traffic.

(structure)

Open port for taking HTTP or HTTPS traffic.

Port -> (integer)

Port for processing traffic.

Type -> (string)

Selection of HTTP or HTTPS traffic.

TlsInterceptProperties -> (structure)

TLS decryption on traffic to filter on attributes in the HTTP header.

PcaArn -> (string)

Private Certificate Authority (PCA) used to issue private TLS certificates so that the proxy can present PCA-signed certificates which applications trust through the same root, establishing a secure and consistent trust model for encrypted communication.

TlsInterceptMode -> (string)

Specifies whether to enable or disable TLS Intercept Mode.

VpcEndpointServiceName -> (string)

The service endpoint created in the VPC.

PrivateDNSName -> (string)

The private DNS name of the Proxy.

CreateTime -> (timestamp)

Time the Proxy was created.

DeleteTime -> (timestamp)

Time the Proxy was deleted.

UpdateTime -> (timestamp)

Time the Proxy was updated.

FailureCode -> (string)

Failure code for cases when the Proxy fails to attach or update.

FailureMessage -> (string)

Failure message for cases when the Proxy fails to attach or update.

Tags -> (list)

The key:value pairs to associate with the resource.

(structure)

A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.

Key -> (string)

The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.

Value -> (string)

The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

UpdateToken -> (string)

A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.

To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the proxy again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.