ListedCertificate - AWS Transfer Family
ContentsSee Also

ListedCertificate

Describes the properties of a certificate.

Contents

ActiveDate

An optional date that specifies when the certificate becomes active.

Type: Timestamp

Required: No

Arn

The Amazon Resource Name (ARN) of the specified certificate.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

Pattern: arn:\S+

Required: No

CertificateId

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

Type: String

Length Constraints: Fixed length of 22.

Pattern: cert-([0-9a-f]{17})

Required: No

Description

The name or short description that's used to identify the certificate.

Type: String

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

Pattern: [\p{Graph}]+

Required: No

InactiveDate

An optional date that specifies when the certificate becomes inactive.

Type: Timestamp

Required: No

Status

The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

Type: String

Valid Values: ACTIVE | PENDING_ROTATION | INACTIVE

Required: No

Type

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.

Type: String

Valid Values: CERTIFICATE | CERTIFICATE_WITH_PRIVATE_KEY

Required: No

Usage

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: String

Valid Values: SIGNING | ENCRYPTION

Required: No

See Also

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