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.
CreateConnector
Crea el conector, que captura los parámetros de una conexión para el SFTP protocolo AS2 o. Para AS2 ello, el conector es necesario para enviar archivos a un AS2 servidor alojado externamente. PuesSFTP, el conector es necesario para enviar archivos a un SFTP servidor o recibir archivos de un SFTP servidor. Para obtener más información sobre los conectores, consulte Configurar AS2 conectores y Crear SFTP conectores.
nota
Debe especificar exactamente un objeto de configuración: para AS2 (As2Config) o SFTP (SftpConfig).
Sintaxis de la solicitud
{
"AccessRole": "string",
"As2Config": {
"BasicAuthSecretId": "string",
"Compression": "string",
"EncryptionAlgorithm": "string",
"LocalProfileId": "string",
"MdnResponse": "string",
"MdnSigningAlgorithm": "string",
"MessageSubject": "string",
"PartnerProfileId": "string",
"SigningAlgorithm": "string"
},
"LoggingRole": "string",
"SftpConfig": {
"TrustedHostKeys": [ "string" ],
"UserSecretId": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"Url": "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 JSON formato.
- AccessRole
-
Los conectores se utilizan para enviar archivos mediante el SFTP protocolo AS2 o. Para el rol de acceso, proporcione el nombre del recurso de Amazon (ARN) del AWS Identity and Access Management rol que se va a usar.
Para AS2 conectores
ConAS2, puede enviar archivos llamando
StartFileTransfery especificando las rutas de los archivos en el parámetro de solicitud,SendFilePaths. Usamos el directorio principal del archivo (por ejemplo, el directorio principal es/bucket/dir/) para--send-file-paths /bucket/dir/file.txtalmacenar temporalmente un archivo de AS2 mensajes procesado, almacenarlo MDN cuando lo recibimos del socio y escribir un JSON archivo final que contiene los metadatos relevantes de la transmisión. Por lo tanto,AccessRoledebe proporcionar acceso de lectura y escritura al directorio principal de la ubicación del archivo que se utiliza en la solicitudStartFileTransfer. Además, debe proporcionar acceso de lectura y escritura al directorio principal de los archivos que desea enviar conStartFileTransfer.Si utiliza la autenticación básica para su AS2 conector, la función de acceso requiere el
secretsmanager:GetSecretValuepermiso del secreto. Si el secreto se cifra con una clave gestionada por el cliente en lugar de la clave AWS gestionada en Secrets Manager, el rol también necesitará elkms:Decryptpermiso para esa clave.Para conectores SFTP
Asegúrese de que el acceso al rol proporcione acceso de lectura y escritura al directorio principal de la ubicación del archivo que se utiliza en la solicitud
StartFileTransfer. Además, asegúrese de que el rol désecretsmanager:GetSecretValuepermiso a AWS Secrets Manager.Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.
Patrón:
arn:.*role/\S+Obligatorio: sí
- As2Config
-
Estructura que contiene los parámetros de un objeto AS2 conector.
Tipo: objeto As2ConnectorConfig
Obligatorio: no
- LoggingRole
-
El nombre del recurso de Amazon (ARN) de la función AWS Identity and Access Management (IAM) que permite a un conector activar el CloudWatch registro de eventos de Amazon S3. Cuando esté configurado, podrá ver la actividad del conector en sus CloudWatch registros.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.
Patrón:
arn:.*role/\S+Obligatorio: no
- SftpConfig
-
Estructura que contiene los parámetros de un objeto SFTP conector.
Tipo: objeto SftpConnectorConfig
Obligatorio: no
- Tags
-
Pares clave-valor que se pueden utilizar para agrupar y buscar conectores. Las etiquetas son metadatos asociados a conectores para cualquier fin.
Tipo: matriz de objetos Tag
Miembros de la matriz: número mínimo de 1 artículo. Número máximo de 50 artículos.
Obligatorio: no
- Url
-
El URL del SFTP punto final AS2 o asociado.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 255 caracteres.
Obligatorio: sí
Sintaxis de la respuesta
{
"ConnectorId": "string"
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta de HTTP 200.
El servicio devuelve los siguientes datos en JSON formato.
- ConnectorId
-
El identificador único del conector, que se devuelve una vez que la API llamada se realiza correctamente.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
c-([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.
HTTPCódigo de estado: 500
- InvalidRequestException
-
Esta excepción se produce cuando el cliente envía una solicitud con un formato incorrecto.
HTTPCódigo de estado: 400
- ResourceExistsException
-
El recurso solicitado no existe o existe en una región distinta de la especificada para el comando.
HTTPCódigo de estado: 400
- ResourceNotFoundException
-
Esta excepción se produce cuando el servicio AWS Transfer Family no encuentra un recurso.
HTTPCódigo de estado: 400
- ServiceUnavailableException
-
La solicitud ha fallado porque el servicio AWS Transfer Family no está disponible.
HTTPCódigo de estado: 500
- ThrottlingException
-
La solicitud fue denegada debido a una limitación de la solicitud.
HTTPCódigo de estado: 400
Ejemplos
Ejemplo
El siguiente ejemplo crea un AS2 conector. En el comando, sustituya los siguientes elementos:
-
url: proporcione URL el AS2 servidor del socio comercial. -
your-IAM-role-for-bucket-access: un IAM rol que tiene acceso al bucket de Amazon S3 que está utilizando para almacenar sus archivos. -
Úselo ARN para su función de registro, que incluye su Cuenta de AWS ID.
-
Proporcione una ruta a un archivo que contenga los parámetros de configuración AS2 del conector. El objeto de configuración AS2 del conector se describe en As2 ConnectorConfig.
// Listing for testAs2Config.json { "LocalProfileId": "your-profile-id", "PartnerProfileId": "partner-profile-id", "MdnResponse": "SYNC", "Compression": "ZLIB", "EncryptionAlgorithm": "AES256_CBC", "SigningAlgorithm": "SHA256", "MdnSigningAlgorithm": "DEFAULT", "MessageSubject": "Your Message Subject" }
aws transfer create-connector --url "http://partner-as2-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --as2-config file://path/to/testAS2Config.json
Ejemplo
En el siguiente ejemplo, se crea un SFTP conector. En el comando, sustituya los siguientes elementos:
-
sftp-server-url: proporcione URL el SFTP servidor con el que está intercambiando archivos. -
your-IAM-role-for-bucket-access: un IAM rol que tiene acceso al bucket de Amazon S3 que está utilizando para almacenar sus archivos. -
Úselo ARN para su función de registro, que incluye su Cuenta de AWS ID.
-
Proporcione una ruta a un archivo que contenga los parámetros de configuración SFTP del conector. El objeto de configuración SFTP del conector se describe en SftpConnectorConfig.
// Listing for testSFTPConfig.json { "UserSecretId": "arn:aws:secretsmanager:us-east-2:123456789012:secret:aws/transfer/example-username-key", "TrustedHostKeys": [ "sftp.example.com ssh-rsa AAAAbbbb...EEEE=" ] }
aws transfer create-connector --url "sftp://sftp-server-url" \ --access-role your-IAM-role-for-bucket-access \ --logging-role arn:aws:iam::your-account-id:role/service-role/AWSTransferLoggingAccess \ --sftp-config file://path/to/testSFTPConfig.json
Ejemplo
La API llamada devuelve el identificador del conector nuevo.
Respuesta de ejemplo
{
"ConnectorId": "a-11112222333344444"
}Véase también
Para obtener más información sobre cómo usarlo API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
