CreateConnector - AWS Transfer Family
Sintassi della richiestaParametri della richiestaSintassi della rispostaElementi di rispostaErroriEsempiVedi anche

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 protocollo AS2 o SFTP. Per AS2, il connettore è necessario per inviare file a un server AS2 ospitato esternamente. Per SFTP, il connettore è necessario quando si inviano file a un server SFTP o si ricevono file da un server SFTP. Per maggiori dettagli sui connettori, consulta Configurare i connettori AS2 e Creare connettori SFTP.

Nota

È necessario specificare esattamente un oggetto di configurazione: per 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",
   "SecurityPolicyName": "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 in formato JSON.

AccessRole

I connettori vengono utilizzati per inviare file utilizzando il protocollo AS2 o SFTP. Per il ruolo di accesso, fornisci l'Amazon Resource Name (ARN) del AWS Identity and Access Management ruolo da utilizzare.

Per connettori AS2

Con AS2, è possibile inviare file chiamando StartFileTransfer e specificando i percorsi dei file nel parametro della richiesta, SendFilePaths. Utilizziamo la directory principale del file (ad esempio, per --send-file-paths /bucket/dir/file.txt, la directory principale è /bucket/dir/) per archiviare temporaneamente un file di messaggio AS2 elaborato, archiviare l'MDN quando lo riceviamo dal partner e scrivere un file JSON finale contenente i metadati pertinenti della trasmissione. Pertanto, AccessRole deve fornire l'accesso in lettura e scrittura alla directory principale della posizione del file utilizzata nella richiesta StartFileTransfer. Inoltre, devi fornire l'accesso in lettura e scrittura alla directory principale dei file che intendi inviare con StartFileTransfer.

Se si utilizza l'autenticazione di base per il connettore AS2, 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 connettori SFTP

Assicurati che il ruolo di accesso fornisca l'accesso in lettura e scrittura alla directory principale della posizione del file utilizzata nella StartFileTransfer richiesta. 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 connettore AS2.

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 registri. CloudWatch

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 20. La lunghezza massima è 2048 caratteri.

Modello: arn:.*role/\S+

Campo obbligatorio: no

SecurityPolicyName

Speciifica il nome della politica di sicurezza per il connettore.

▬Tipo: stringa

Limitazioni di lunghezza: lunghezza minima di 0. Lunghezza massima di 100.

Modello: TransferSFTPConnectorSecurityPolicy-[A-Za-z0-9-]+

Campo obbligatorio: no

SftpConfig

Una struttura che contiene i parametri per un oggetto connettore SFTP.

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

L'URL dell'endpoint AS2 o SFTP del partner.

▬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'operazione riesce, il servizio restituisce una risposta HTTP 200.

I dati seguenti vengono restituiti in formato JSON mediante il servizio.

ConnectorId

L'identificatore univoco del connettore, restituito dopo l'esito positivo della chiamata API.

▬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

Codice di stato HTTP: 500

InvalidRequestException

Questa eccezione viene generata quando il client invia una richiesta non valida.

Codice di stato HTTP: 400

ResourceExistsException

La risorsa richiesta non esiste o esiste in una regione diversa da quella specificata per il comando.

Codice di stato HTTP: 400

ResourceNotFoundException

Questa eccezione viene generata quando una risorsa non viene trovata dal servizio AWS Transfer Family.

Codice di stato HTTP: 400

ServiceUnavailableException

La richiesta non è riuscita perché il servizio AWS Transfer Family non è disponibile.

Codice di stato HTTP: 500

ThrottlingException

La richiesta è stata negata a causa del throttling della richiesta.

Codice di stato HTTP: 400

Esempi

Esempio

L'esempio seguente crea un connettore AS2. Nel comando, sostituite gli elementi come segue:

  • url: fornisce l'URL per il server AS2 del partner commerciale.

  • your-IAM-role-for-bucket-access: un ruolo IAM che ha accesso al bucket Amazon S3 che stai utilizzando per archiviare i tuoi file.

  • Usa l'ARN per il tuo ruolo di registrazione, che include il tuo ID. Account AWS

  • Fornisci un percorso a un file che contiene i parametri di configurazione del connettore AS2. L'oggetto di configurazione del connettore AS2 è 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 connettore SFTP. Nel comando, sostituite gli elementi come segue:

  • sftp-server-url: fornite l'URL del server SFTP con cui state scambiando file.

  • your-IAM-role-for-bucket-access: un ruolo IAM che ha accesso al bucket Amazon S3 che stai utilizzando per archiviare i tuoi file.

  • Usa l'ARN per il tuo ruolo di registrazione, che include il tuo ID. Account AWS

  • Fornite un percorso a un file che contiene i parametri di configurazione del connettore SFTP. L'oggetto di configurazione del connettore SFTP è 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 chiamata API restituisce l'ID del connettore per il nuovo connettore.

Risposta di esempio

{
    "ConnectorId": "a-11112222333344444"
}

Vedi anche

Per ulteriori informazioni sull'utilizzo di questa API in uno degli AWS SDK specifici della lingua, consulta quanto segue: