DescribedCertificate
Describes the properties of a certificate.
Contents
- Arn
-
The unique Amazon Resource Name (ARN) for the certificate.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1600.
Pattern:
arn:\S+Required: Yes
- ActiveDate
-
An optional date that specifies when the certificate becomes active.
Type: Timestamp
Required: No
- Certificate
-
The file name for the certificate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16384.
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]*Required: No
- CertificateChain
-
The list of certificates that make up the chain for the certificate.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2097152.
Pattern:
[\u0009\u000A\u000D\u0020-\u00FF]*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 description that's used to identity 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
- NotAfterDate
-
The final date that the certificate is valid.
Type: Timestamp
Required: No
- NotBeforeDate
-
The earliest date that the certificate is valid.
Type: Timestamp
Required: No
- Serial
-
The serial number for the certificate.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 48.
Pattern:
[\p{XDigit}{2}:?]*Required: No
- Status
-
Currently, the only available status is
ACTIVE: all other values are reserved for future use.Type: String
Valid Values:
ACTIVE | PENDING_ROTATION | INACTIVERequired: No
- Tags
-
Key-value pairs that can be used to group and search for certificates.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
- Type
-
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 isCERTIFICATE.Type: String
Valid Values:
CERTIFICATE | CERTIFICATE_WITH_PRIVATE_KEYRequired: 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 | ENCRYPTIONRequired: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
