ImportCertificate - Amazon Transfer Family
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ImportCertificate

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

Request Syntax

{ "ActiveDate": number, "Certificate": "string", "CertificateChain": "string", "Description": "string", "InactiveDate": number, "PrivateKey": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Usage": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ActiveDate

An optional date that specifies when the certificate becomes active.

Type: Timestamp

Required: No

Certificate

The file that contains the certificate to import.

Type: String

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

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]*

Required: Yes

CertificateChain

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

Type: String

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

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]*

Required: No

Description

A short description that helps 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

PrivateKey

The file that contains the private key for the certificate that's being imported.

Type: String

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

Pattern: ^[\u0009\u000A\u000D\u0020-\u00FF]*

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

Usage

Specifies whether this certificate is used for signing or encryption.

Type: String

Valid Values: SIGNING | ENCRYPTION

Required: Yes

Response Syntax

{ "CertificateId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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})$

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AmazonTransfer Family service.

HTTP Status Code: 500

InvalidRequestException

This exception is thrown when the client submits a malformed request.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AmazonTransfer Family service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AmazonTransfer Family service is not available.

HTTP Status Code: 500

See Also

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