ImportCertificate - AWS Transfer Family

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ImportCertificate

Importe les certificats de signature et de chiffrement dont vous avez besoin pour créer des profils locaux (AS2) et des profils de partenaires.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

La demande accepte les données suivantes au JSON format suivant.

ActiveDate

Une date facultative qui indique à quel moment le certificat devient actif.

Type : Timestamp

Obligatoire : non

Certificate
  • Pour leCLI, fournissez un chemin de fichier pour un certificat au URI format. Par exemple, --certificate file://encryption-cert.pem. Vous pouvez également fournir le contenu brut.

  • Pour leSDK, spécifiez le contenu brut d'un fichier de certificat. Par exemple, --certificate "`cat encryption-cert.pem`".

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 16384.

Modèle : [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatoire : oui

CertificateChain

Liste facultative de certificats qui constituent la chaîne du certificat en cours d'importation.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 2097152.

Modèle : [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatoire : non

Description

Brève description qui permet d'identifier le certificat.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 200.

Modèle : [\p{Graph}]+

Obligatoire : non

InactiveDate

Une date facultative qui indique à quel moment le certificat devient inactif.

Type : Timestamp

Obligatoire : non

PrivateKey
  • Pour leCLI, fournissez un chemin de fichier pour une clé privée au URI format. Par exemple,. --private-key file://encryption-key.pem Vous pouvez également fournir le contenu brut du fichier de clé privée.

  • Pour leSDK, spécifiez le contenu brut d'un fichier de clé privée. Par exemple, --private-key "`cat encryption-key.pem`"

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximale de 16384.

Modèle : [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatoire : non

Tags

Paires clé-valeur qui peuvent être utilisées pour regrouper et rechercher des certificats.

Type : tableau d’objets Tag

Membres du tableau : Nombre minimum de 1 élément. Nombre maximal de 50 éléments.

Obligatoire : non

Usage

Spécifie si ce certificat est utilisé pour la signature ou le chiffrement.

Type : String

Valeurs valides : SIGNING | ENCRYPTION

Obligatoire : oui

Syntaxe de la réponse

{ "CertificateId": "string" }

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées sous JSON forme formatée par le service.

CertificateId

Un tableau d'identifiants pour les certificats importés. Vous utilisez cet identifiant pour travailler avec des profils et des profils de partenaires.

Type : String

Contraintes de longueur : longueur fixe de 22.

Modèle : cert-([0-9a-f]{17})

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalServiceError

Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.

HTTPCode de statut : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

HTTPCode de statut : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

HTTPCode de statut : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

HTTPCode de statut : 500

Exemples

Exemple

L'exemple suivant importe un certificat à utiliser pour le chiffrement. Dans la première commande, nous fournissons le contenu du certificat et des fichiers de chaîne de certificats. Utilisez ce format pour SDK les commandes.

aws transfer import-certificate --usage ENCRYPTION --certificate "`cat encryption-cert.pem`" \ --private-key "`cat encryption-key.pem`" --certificate-chain "`cat root-ca.pem`"

Exemple

L'exemple suivant est identique à la commande précédente, sauf que nous indiquons les emplacements des fichiers de clé privée, de certificat et de chaîne de certificats. Cette version de la commande ne fonctionne pas si vous utilisez unSDK.

aws transfer import-certificate --usage ENCRYPTION --certificate file://encryption-cert.pem \ --private-key file://encryption-key.pem --certificate-chain file://root-ca.pem

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :