NetworkFirewall / Client / delete_tls_inspection_configuration
delete_tls_inspection_configuration#
- NetworkFirewall.Client.delete_tls_inspection_configuration(**kwargs)#
Deletes the specified TLSInspectionConfiguration.
See also: AWS API Documentation
Request Syntax
response = client.delete_tls_inspection_configuration( TLSInspectionConfigurationArn='string', TLSInspectionConfigurationName='string' )
- Parameters:
TLSInspectionConfigurationArn (string) –
The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName (string) –
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.
- Return type:
dict
- Returns:
Response Syntax
{ 'TLSInspectionConfigurationResponse': { 'TLSInspectionConfigurationArn': 'string', 'TLSInspectionConfigurationName': 'string', 'TLSInspectionConfigurationId': 'string', 'TLSInspectionConfigurationStatus': 'ACTIVE'|'DELETING'|'ERROR', 'Description': 'string', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'LastModifiedTime': datetime(2015, 1, 1), 'NumberOfAssociations': 123, 'EncryptionConfiguration': { 'KeyId': 'string', 'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY' }, 'Certificates': [ { 'CertificateArn': 'string', 'CertificateSerial': 'string', 'Status': 'string', 'StatusMessage': 'string' }, ], 'CertificateAuthority': { 'CertificateArn': 'string', 'CertificateSerial': 'string', 'Status': 'string', 'StatusMessage': 'string' } } }
Response Structure
(dict) –
TLSInspectionConfigurationResponse (dict) –
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.
TLSInspectionConfigurationArn (string) –
The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationName (string) –
The descriptive name of the TLS inspection configuration. You can’t change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationId (string) –
A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
TLSInspectionConfigurationStatus (string) –
Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
Description (string) –
A description of the TLS inspection configuration.
Tags (list) –
The key:value pairs to associate with the resource.
(dict) –
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.
LastModifiedTime (datetime) –
The last time that the TLS inspection configuration was changed.
NumberOfAssociations (integer) –
The number of firewall policies that use this TLS inspection configuration.
EncryptionConfiguration (dict) –
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
KeyId (string) –
The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you’re using a key that’s managed by another account. If you’re using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type (string) –
The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
Certificates (list) –
A list of the certificates associated with the TLS inspection configuration.
(dict) –
Contains metadata about an Certificate Manager certificate.
CertificateArn (string) –
The Amazon Resource Name (ARN) of the certificate.
CertificateSerial (string) –
The serial number of the certificate.
Status (string) –
The status of the certificate.
StatusMessage (string) –
Contains details about the certificate status, including information about certificate errors.
CertificateAuthority (dict) –
Contains metadata about an Certificate Manager certificate.
CertificateArn (string) –
The Amazon Resource Name (ARN) of the certificate.
CertificateSerial (string) –
The serial number of the certificate.
Status (string) –
The status of the certificate.
StatusMessage (string) –
Contains details about the certificate status, including information about certificate errors.
Exceptions
NetworkFirewall.Client.exceptions.InvalidRequestException
NetworkFirewall.Client.exceptions.InternalServerError
NetworkFirewall.Client.exceptions.ResourceNotFoundException
NetworkFirewall.Client.exceptions.ThrottlingException
NetworkFirewall.Client.exceptions.InvalidOperationException