ImportCertificate - AWS Transfer Family

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

ImportCertificate

Importa los certificados de firma y cifrado que necesita para crear perfiles locales (AS2) y perfiles de socios.

Sintaxis de la solicitud

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

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

ActiveDate

Una fecha opcional que especifica cuándo se activa el certificado.

Tipo: marca temporal

Obligatorio: no

Certificate
  • Para la CLI, proporcione una ruta de archivo para un certificado en formato URI. Por ejemplo, --certificate file://encryption-cert.pem. Si lo desea, también puede proporcionar el contenido sin procesar.

  • Para el SDK, especifique el contenido sin procesar de un archivo de certificado. Por ejemplo, --certificate "`cat encryption-cert.pem`".

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 16384 caracteres.

Patrón: [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatorio: sí

CertificateChain

Una lista opcional de certificados que forman la cadena del certificado que se está importando.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 2097152.

Patrón: [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatorio: no

Description

Una breve descripción que ayuda a identificar el certificado.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.

Patrón: [\p{Graph}]+

Obligatorio: no

InactiveDate

Una fecha opcional que especifica cuándo el certificado pasa a estar inactivo.

Tipo: marca temporal

Obligatorio: no

PrivateKey
  • Para la CLI, proporcione una ruta de archivo para una clave privada en formato URI. Por ejemplo, --private-key file://encryption-key.pem. Como alternativa, puede proporcionar el contenido sin procesar del archivo de clave privada.

  • Para el SDK, especifique el contenido sin procesar de un archivo de clave privada. Por ejemplo, --private-key "`cat encryption-key.pem`"

Tipo: string

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 16384 caracteres.

Patrón: [\u0009\u000A\u000D\u0020-\u00FF]*

Obligatorio: no

Tags

Pares clave-valor que se pueden utilizar para agrupar y buscar certificados.

Tipo: Matriz de Tag objetos

Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 50 artículos.

Obligatorio: no

Usage

Especifica cómo se utiliza este certificado. Se puede utilizar de las siguientes maneras:

  • SIGNING: Para firmar mensajes AS2

  • ENCRYPTION: Para cifrar mensajes AS2

  • TLS: Para proteger las comunicaciones AS2 enviadas a través de HTTPS

Tipo: cadena

Valores válidos: SIGNING | ENCRYPTION

Obligatorio: sí

Sintaxis de la respuesta

{ "CertificateId": "string" }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CertificateId

Una matriz de identificadores de los certificados importados. Este identificador se utiliza para trabajar con perfiles y perfiles de socios.

Tipo: cadena

Limitaciones de longitud: longitud fija de 22.

Patrón: cert-([0-9a-f]{17})

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

InternalServiceError

Esta excepción se produce cuando se produce un error en el AWS Transfer Family servicio.

Código de estado HTTP: 500

InvalidRequestException

Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.

Código de estado HTTP: 400

ResourceNotFoundException

Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.

Código de estado HTTP: 400

ServiceUnavailableException

La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.

Código de estado HTTP: 500

Ejemplos

Ejemplo

En el siguiente ejemplo, se importa un certificado para usarlo en el cifrado. En el primer comando, proporcionamos el contenido del certificado y de los archivos de la cadena de certificados. Use este formato para los comandos del SDK.

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

Ejemplo

El siguiente ejemplo es idéntico al comando anterior, excepto que proporcionamos las ubicaciones de los archivos de la clave privada, el certificado y la cadena de certificados. Esta versión del comando no funciona si utiliza un SDK.

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

Véase también

Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulta lo siguiente: