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.
UpdateConnector
Actualiza algunos de los parámetros de un conector existente. Proporcione el valor ConnectorId del conector que desee actualizar, junto con los nuevos valores de los parámetros que desee actualizar.
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"
},
"ConnectorId": "string",
"LoggingRole": "string",
"SecurityPolicyName": "string",
"SftpConfig": {
"TrustedHostKeys": [ "string" ],
"UserSecretId": "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 formato JSON.
- AccessRole
-
Los conectores se utilizan para enviar archivos mediante el protocolo AS2 o SFTP. Para la función de acceso, proporcione el nombre de recurso de Amazon (ARN) de la AWS Identity and Access Management función que se va a utilizar.
Para conectores AS2
Con AS2, puede enviar archivos llamando a
StartFileTransfery especificando las rutas de los archivos en el parámetro de solicitud,SendFilePaths. Utilizamos el directorio principal del archivo (por ejemplo, para--send-file-paths /bucket/dir/file.txt, el directorio principal es/bucket/dir/) para almacenar temporalmente un archivo de mensajes AS2 procesado, almacenar el MDN cuando lo recibimos del socio y escribir un archivo JSON final que contenga 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 el conector AS2, el rol de acceso requiere el permiso
secretsmanager:GetSecretValuepara el 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 otorguesecretsmanager:GetSecretValuepermiso a. AWS Secrets ManagerTipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 2048 caracteres.
Patrón:
arn:.*role/\S+Obligatorio: no
- As2Config
-
Una estructura que contiene los parámetros de un objeto de conexión AS2.
Tipo: objeto As2ConnectorConfig
Obligatorio: no
- ConnectorId
-
Un identificador único para el conector.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
c-([0-9a-f]{17})Obligatorio: sí
- LoggingRole
-
El nombre de recurso de Amazon (ARN) de la función AWS Identity and Access Management (IAM) que permite a un conector activar el CloudWatch registro de los 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
- SecurityPolicyName
-
Especifica el nombre de la política de seguridad del conector.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 100 caracteres.
Patrón:
TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+Obligatorio: no
- SftpConfig
-
Una estructura que contiene los parámetros de un objeto de conexión SFTP.
Tipo: objeto SftpConnectorConfig
Obligatorio: no
- Url
-
La URL del punto de conexión de AS2 o SFTP del socio.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 255 caracteres.
Obligatorio: no
Sintaxis de la respuesta
{
"ConnectorId": "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.
- ConnectorId
-
Devuelve el identificador del objeto conector que está actualizando.
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.
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
- ResourceExistsException
-
El recurso solicitado no existe o existe en una región distinta de la especificada para el comando.
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
- ThrottlingException
-
La solicitud fue denegada debido a una limitación de la solicitud.
Código de estado HTTP: 400
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:
