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à.
DescribeWorkflow
Descrive il flusso di lavoro specificato.
Sintassi della richiesta
{
"WorkflowId": "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.
- WorkflowId
-
Un identificatore univoco per il flusso di lavoro.
Tipo: stringa
Vincoli di lunghezza: lunghezza fissa di 19.
Modello:
w-([a-z0-9]{17})
Campo obbligatorio: sì
Sintassi della risposta
{
"Workflow": {
"Arn": "string",
"Description": "string",
"OnExceptionSteps": [
{
"CopyStepDetails": {
"DestinationFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
}
},
"Name": "string",
"OverwriteExisting": "string",
"SourceFileLocation": "string"
},
"CustomStepDetails": {
"Name": "string",
"SourceFileLocation": "string",
"Target": "string",
"TimeoutSeconds": number
},
"DecryptStepDetails": {
"DestinationFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
}
},
"Name": "string",
"OverwriteExisting": "string",
"SourceFileLocation": "string",
"Type": "string"
},
"DeleteStepDetails": {
"Name": "string",
"SourceFileLocation": "string"
},
"TagStepDetails": {
"Name": "string",
"SourceFileLocation": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
},
"Type": "string"
}
],
"Steps": [
{
"CopyStepDetails": {
"DestinationFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
}
},
"Name": "string",
"OverwriteExisting": "string",
"SourceFileLocation": "string"
},
"CustomStepDetails": {
"Name": "string",
"SourceFileLocation": "string",
"Target": "string",
"TimeoutSeconds": number
},
"DecryptStepDetails": {
"DestinationFileLocation": {
"EfsFileLocation": {
"FileSystemId": "string",
"Path": "string"
},
"S3FileLocation": {
"Bucket": "string",
"Key": "string"
}
},
"Name": "string",
"OverwriteExisting": "string",
"SourceFileLocation": "string",
"Type": "string"
},
"DeleteStepDetails": {
"Name": "string",
"SourceFileLocation": "string"
},
"TagStepDetails": {
"Name": "string",
"SourceFileLocation": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
},
"Type": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"WorkflowId": "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.
- Workflow
-
La struttura che contiene i dettagli del flusso di lavoro.
Tipo: oggetto DescribedWorkflow
Errori
Per informazioni sugli errori comuni a tutte le operazioni, consultare Errori comuni.
- InternalServiceError
-
Questa eccezione viene generata quando si verifica un errore nel AWS Transfer Family servizio.
HTTPCodice di stato: 500
- InvalidRequestException
-
Questa eccezione viene generata quando il client invia una richiesta non valida.
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
Vedi anche
Per ulteriori informazioni sull'utilizzo API in una delle lingue specifiche AWS SDKs, consulta quanto segue: