DescribeTLSInspectionConfiguration - AWS Network Firewall

DescribeTLSInspectionConfiguration

Returns the data objects for the specified TLS inspection configuration.

Request Syntax

{ "TLSInspectionConfigurationArn": "string", "TLSInspectionConfigurationName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

TLSInspectionConfigurationArn

The Amazon Resource Name (ARN) of the TLS inspection configuration.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:aws.*

Required: No

TLSInspectionConfigurationName

The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

Response Syntax

{ "TLSInspectionConfiguration": { "ServerCertificateConfigurations": [ { "Scopes": [ { "DestinationPorts": [ { "FromPort": number, "ToPort": number } ], "Destinations": [ { "AddressDefinition": "string" } ], "Protocols": [ number ], "SourcePorts": [ { "FromPort": number, "ToPort": number } ], "Sources": [ { "AddressDefinition": "string" } ] } ], "ServerCertificates": [ { "ResourceArn": "string" } ] } ] }, "TLSInspectionConfigurationResponse": { "Certificates": [ { "CertificateArn": "string", "CertificateSerial": "string", "Status": "string", "StatusMessage": "string" } ], "Description": "string", "EncryptionConfiguration": { "KeyId": "string", "Type": "string" }, "LastModifiedTime": number, "NumberOfAssociations": number, "Tags": [ { "Key": "string", "Value": "string" } ], "TLSInspectionConfigurationArn": "string", "TLSInspectionConfigurationId": "string", "TLSInspectionConfigurationName": "string", "TLSInspectionConfigurationStatus": "string" }, "UpdateToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TLSInspectionConfiguration

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS inspection configurations in the AWS Network Firewall Developer Guide.

Type: TLSInspectionConfiguration object

TLSInspectionConfigurationResponse

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Type: TLSInspectionConfigurationResponse object

UpdateToken

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

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

HTTP Status Code: 500

InvalidRequestException

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

HTTP Status Code: 400

ResourceNotFoundException

Unable to locate a resource using the parameters that you provided.

HTTP Status Code: 400

ThrottlingException

Unable to process the request due to throttling limitations.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: