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.
DescribedAgreement
Describe las propiedades de un acuerdo.
Contenido
- Arn
-
El nombre exclusivo del recurso de Amazon (ARN) del acuerdo.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
Patrón:
arn:\S+
Obligatorio: sí
- AccessRole
-
Los conectores se utilizan para enviar archivos mediante el SFTP protocolo AS2 o. 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 AS2 conectores
ConAS2, puede enviar archivos llamando
StartFileTransfer
y 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.txt
almacenar 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,AccessRole
debe 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:GetSecretValue
permiso 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:Decrypt
permiso 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:GetSecretValue
permiso 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: no
- AgreementId
-
Un identificador único para el acuerdo. Este identificador se devuelve al crear un acuerdo.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
a-([0-9a-f]{17})
Obligatorio: no
- BaseDirectory
-
El directorio de destino (carpeta) de los archivos que se transfieren mediante el AS2 protocolo.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 0. La longitud máxima es de 1024 caracteres.
Patrón:
(|/.*)
Obligatorio: no
- Description
-
El nombre o la descripción breve utilizados para identificar el acuerdo.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 200 caracteres.
Patrón:
[\p{Graph}]+
Obligatorio: no
- LocalProfileId
-
Un identificador único para el perfil AS2 local.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
p-([0-9a-f]{17})
Obligatorio: no
- PartnerProfileId
-
Un identificador único para el perfil de socio utilizado en el acuerdo.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
p-([0-9a-f]{17})
Obligatorio: no
- ServerId
-
Identificador único asignado por el sistema para una instancia del servidor. Este identificador indica el servidor específico utilizado en el acuerdo.
Tipo: cadena
Limitaciones de longitud: longitud fija de 19.
Patrón:
s-([0-9a-f]{17})
Obligatorio: no
- Status
-
El estado actual del acuerdo, ya sea
ACTIVE
oINACTIVE
.Tipo: cadena
Valores válidos:
ACTIVE | INACTIVE
Obligatorio: no
- Tags
-
Pares clave-valor que se pueden utilizar para agrupar y buscar acuerdos.
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
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: