Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
CreateConnector
Crea il connettore, che acquisisce i parametri per una connessione per il SFTP protocollo AS2 or. InfattiAS2, il connettore è necessario per inviare file a un server ospitato esternamente. AS2 InfattiSFTP, il connettore è necessario quando si inviano file a un SFTP server o si ricevono file da un SFTP server. Per ulteriori dettagli sui connettori, vedere Configurare i AS2 connettori e Creare SFTP connettori.
Nota
È necessario specificare esattamente un oggetto di configurazione: for AS2 (As2Config) o SFTP (SftpConfig).
Sintassi della richiesta
{
"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"
}Parametri della richiesta
Per informazioni sui parametri comuni per tutte le azioni, consulta Parametri comuni.
La richiesta accetta i seguenti dati nel JSON formato.
- AccessRole
-
I connettori vengono utilizzati per inviare file utilizzando il SFTP protocollo AS2 or. Per il ruolo di accesso, fornisci l'Amazon Resource Name (ARN) del AWS Identity and Access Management ruolo da utilizzare.
Per i AS2 connettori
ConAS2, è possibile inviare file chiamando
StartFileTransfere specificando i percorsi dei file nel parametro di richiesta,SendFilePaths. Utilizziamo la directory principale del file (ad esempio, for--send-file-paths /bucket/dir/file.txt, la directory principale is/bucket/dir/) per archiviare temporaneamente un file di AS2 messaggio elaborato, memorizzare il MDN momento in cui li riceviamo dal partner e scrivere un JSON file finale contenente i metadati pertinenti della trasmissione. Pertanto,AccessRoledeve fornire l'accesso in lettura e scrittura alla directory principale della posizione del file utilizzata nella richiestaStartFileTransfer. Inoltre, devi fornire l'accesso in lettura e scrittura alla directory principale dei file che intendi inviare conStartFileTransfer.Se si utilizza l'autenticazione di base per il AS2 connettore, il ruolo di accesso richiede l'
secretsmanager:GetSecretValueautorizzazione per il segreto. Se il segreto viene crittografato utilizzando una chiave gestita dal cliente anziché la chiave AWS gestita in Secrets Manager, il ruolo necessita anche dell'kms:Decryptautorizzazione per quella chiave.Per i connettori SFTP
Assicurati che il ruolo di accesso fornisca l'accesso in lettura e scrittura alla directory principale della posizione del file utilizzata nella
StartFileTransferrichiesta. Inoltre, assicurati che il ruolo fornisca l'secretsmanager:GetSecretValueautorizzazione a AWS Secrets Manager.Tipo: stringa
Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 2048 caratteri.
Modello:
arn:.*role/\S+Campo obbligatorio: sì
- As2Config
-
Una struttura che contiene i parametri per un oggetto AS2 connettore.
Tipo: oggetto As2ConnectorConfig
Campo obbligatorio: no
- LoggingRole
-
L'Amazon Resource Name (ARN) del ruolo AWS Identity and Access Management (IAM) che consente a un connettore di attivare la CloudWatch registrazione per gli eventi Amazon S3. Una volta impostato, puoi visualizzare l'attività del connettore nei tuoi CloudWatch log.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 2048 caratteri.
Modello:
arn:.*role/\S+Campo obbligatorio: no
- SftpConfig
-
Una struttura che contiene i parametri per un oggetto SFTP connettore.
Tipo: oggetto SftpConnectorConfig
Campo obbligatorio: no
- Tags
-
Le coppie chiave-valore che è possibile utilizzare per raggruppare e cercare i connettori. I tag sono metadati allegati ai connettori per qualsiasi scopo.
Tipo: matrice di oggetti Tag
Membri dell’array: numero minimo di 1 elemento. Numero massimo di 50 item.
Campo obbligatorio: no
- Url
-
Il URL punto del partner AS2 o dell'SFTPendpoint.
Tipo: stringa
Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 255.
Campo obbligatorio: sì
Sintassi della risposta
{
"ConnectorId": "string"
}Elementi di risposta
Se l'azione ha esito positivo, il servizio restituisce una risposta di HTTP 200.
I seguenti dati vengono restituiti in JSON formato dal servizio.
- ConnectorId
-
L'identificatore univoco del connettore, restituito dopo l'esito positivo della API chiamata.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
c-([0-9a-f]{17})
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- InternalServiceError
-
Questa eccezione viene generata quando si verifica un errore nel servizio. AWS Transfer Family
HTTPCodice di stato: 500
- InvalidRequestException
-
Questa eccezione viene generata quando il client invia una richiesta non valida.
HTTPCodice di stato: 400
- ResourceExistsException
-
La risorsa richiesta non esiste o esiste in una regione diversa da quella specificata per il comando.
HTTPCodice di stato: 400
- ResourceNotFoundException
-
Questa eccezione viene generata quando una risorsa non viene trovata dal servizio AWS Transfer Family.
HTTPCodice di stato: 400
- ServiceUnavailableException
-
La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.
HTTPCodice di stato: 500
- ThrottlingException
-
La richiesta è stata negata a causa del throttling della richiesta.
HTTPCodice di stato: 400
Esempi
Esempio
L'esempio seguente crea un AS2 connettore. Nel comando, sostituite gli elementi come segue:
-
url: fornisce URL il AS2 server del partner commerciale. -
your-IAM-role-for-bucket-access: un IAM ruolo che ha accesso al bucket Amazon S3 che stai utilizzando per archiviare i tuoi file. -
Usa il ruolo ARN per la registrazione, che include il tuo ID. Account AWS
-
Fornisci un percorso a un file che contiene i parametri di configurazione del AS2 connettore. L'oggetto di configurazione del AS2 connettore è descritto in 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
Esempio
L'esempio seguente crea un SFTP connettore. Nel comando, sostituite gli elementi come segue:
-
sftp-server-url: fornite il URL per il SFTP server con cui state scambiando i file. -
your-IAM-role-for-bucket-access: un IAM ruolo che ha accesso al bucket Amazon S3 che stai utilizzando per archiviare i tuoi file. -
Usa il ruolo ARN per la registrazione, che include il tuo ID. Account AWS
-
Fornisci un percorso a un file che contiene i parametri di configurazione del SFTP connettore. L'oggetto di configurazione del SFTP connettore è descritto in 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
Esempio
La API chiamata restituisce l'ID del connettore per il nuovo connettore.
Risposta di esempio
{
"ConnectorId": "a-11112222333344444"
}Vedi anche
Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue:
