Transfer / Client / describe_certificate

describe_certificate#

Transfer.Client.describe_certificate(**kwargs)#

Describes the certificate that’s identified by the CertificateId.

Request Syntax

response = client.describe_certificate(
    CertificateId='string'
)

Parameters:

CertificateId (string) –

[REQUIRED]

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

Return type:

dict

Returns:

Response Syntax

{
    'Certificate': {
        'Arn': 'string',
        'CertificateId': 'string',
        'Usage': 'SIGNING'|'ENCRYPTION'|'TLS',
        'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE',
        'Certificate': 'string',
        'CertificateChain': 'string',
        'ActiveDate': datetime(2015, 1, 1),
        'InactiveDate': datetime(2015, 1, 1),
        'Serial': 'string',
        'NotBeforeDate': datetime(2015, 1, 1),
        'NotAfterDate': datetime(2015, 1, 1),
        'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- Certificate (dict) –
  
  The details for the specified certificate, returned as an object.
  - Arn (string) –
    
    The unique Amazon Resource Name (ARN) for the certificate.
  - CertificateId (string) –
    
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - Usage (string) –
    
    Specifies how this certificate is used. It can be used in the following ways:
    - SIGNING: For signing AS2 messages
    - ENCRYPTION: For encrypting AS2 messages
    - TLS: For securing AS2 communications sent over HTTPS
  - Status (string) –
    
    Currently, the only available status is ACTIVE: all other values are reserved for future use.
  - Certificate (string) –
    
    The file name for the certificate.
  - CertificateChain (string) –
    
    The list of certificates that make up the chain for the certificate.
  - ActiveDate (datetime) –
    
    An optional date that specifies when the certificate becomes active.
  - InactiveDate (datetime) –
    
    An optional date that specifies when the certificate becomes inactive.
  - Serial (string) –
    
    The serial number for the certificate.
  - NotBeforeDate (datetime) –
    
    The earliest date that the certificate is valid.
  - NotAfterDate (datetime) –
    
    The final date that the certificate is valid.
  - Type (string) –
    
    If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
  - Description (string) –
    
    The name or description that’s used to identity the certificate.
  - Tags (list) –
    
    Key-value pairs that can be used to group and search for certificates.
    - (dict) –
      
      Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.
      - Key (string) –
        
        The name assigned to the tag that you create.
      - Value (string) –
        
        Contains one or more values that you assigned to the key name you create.

Exceptions

Transfer.Client.exceptions.ResourceNotFoundException
Transfer.Client.exceptions.InvalidRequestException
Transfer.Client.exceptions.InternalServiceError
Transfer.Client.exceptions.ServiceUnavailableException