AWS API Changes

2024/04/12 - AWS Transfer Family - 3 updated api methods

Changes This change releases support for importing self signed certificates to the Transfer Family for sending outbound file transfers over TLS/HTTPS.

DescribeCertificate (updated)

Link ¶
Changes (response)

{'Certificate': {'Usage': {'TLS'}}}

Describes the certificate that's identified by the CertificateId.

See also: AWS API Documentation

Request Syntax

client.describe_certificate(
    CertificateId='string'
)

type CertificateId:

string

param CertificateId:

[REQUIRED]

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

rtype:

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) --
    
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
  - 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.

ImportCertificate (updated)

Link ¶
Changes (request)

{'Usage': {'TLS'}}

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

See also: AWS API Documentation

Request Syntax

client.import_certificate(
    Usage='SIGNING'|'ENCRYPTION'|'TLS',
    Certificate='string',
    CertificateChain='string',
    PrivateKey='string',
    ActiveDate=datetime(2015, 1, 1),
    InactiveDate=datetime(2015, 1, 1),
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Usage:

string

param Usage:

[REQUIRED]

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

type Certificate:

string

param Certificate:

[REQUIRED]

For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.
For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

type CertificateChain:

string

param CertificateChain:

An optional list of certificates that make up the chain for the certificate that's being imported.

type PrivateKey:

string

param PrivateKey:

For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.
For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

type ActiveDate:

datetime

param ActiveDate:

An optional date that specifies when the certificate becomes active.

type InactiveDate:

datetime

param InactiveDate:

An optional date that specifies when the certificate becomes inactive.

type Description:

string

param Description:

A short description that helps identify the certificate.

type Tags:

list

param Tags:

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) -- [REQUIRED]
  
  The name assigned to the tag that you create.
- Value (string) -- [REQUIRED]
  
  Contains one or more values that you assigned to the key name you create.

rtype:

dict

returns:

Response Syntax

{
    'CertificateId': 'string'
}

Response Structure

(dict) --
- CertificateId (string) --
  
  An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

ListCertificates (updated)

Link ¶
Changes (response)

{'Certificates': {'Usage': {'TLS'}}}

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

See also: AWS API Documentation

Request Syntax

client.list_certificates(
    MaxResults=123,
    NextToken='string'
)

type MaxResults:

integer

param MaxResults:

The maximum number of certificates to return.

type NextToken:

string

param NextToken:

When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Certificates': [
        {
            'Arn': 'string',
            'CertificateId': 'string',
            'Usage': 'SIGNING'|'ENCRYPTION'|'TLS',
            'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE',
            'ActiveDate': datetime(2015, 1, 1),
            'InactiveDate': datetime(2015, 1, 1),
            'Type': 'CERTIFICATE'|'CERTIFICATE_WITH_PRIVATE_KEY',
            'Description': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  Returns the next token, which you can use to list the next certificate.
- Certificates (list) --
  
  Returns an array of the certificates that are specified in the ListCertificates call.
  - (dict) --
    
    Describes the properties of a certificate.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the specified 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) --
      
      The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    - ActiveDate (datetime) --
      
      An optional date that specifies when the certificate becomes active.
    - InactiveDate (datetime) --
      
      An optional date that specifies when the certificate becomes inactive.
    - Type (string) --
      
      The type for the certificate. 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 short description that's used to identify the certificate.