AddApplicationReferenceDataSource - Guide du développeur d'Amazon Kinesis Data Analytics SQL pour applications
Syntaxe de la requêteParamètres de demandeÉléments de réponseErreursconsultez aussi

Pour les nouveaux projets, nous vous recommandons d'utiliser le nouveau service géré pour Apache Flink Studio plutôt que Kinesis Data Analytics SQL for Applications. Le service géré pour Apache Flink Studio allie facilité d’utilisation et capacités analytiques avancées, ce qui vous permet de créer des applications sophistiquées de traitement des flux en quelques minutes.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AddApplicationReferenceDataSource

Note

Cette documentation est destinée à la version 1 de l’API Amazon Kinesis Data Analytics, qui est compatible uniquement avec les applications SQL. La version 2 de l’API est compatible avec les applications SQL et Java. Pour plus d’informations sur la version 2, consultez la documentation de l’API Amazon Kinesis Data Analytics V2.

Ajoute une source de données de référence à une application existante.

Amazon Kinesis Analytics lit les données de référence (un objet Amazon S3) et crée une table intégrée à l'application dans votre application. Dans la demande, vous fournissez la source (le nom du compartiment S3 et le nom de la clé d'objet), le nom de la table intégrée à l'application à créer et les informations de mappage nécessaires qui décrivent la façon dont les données d'objet Amazon S3 sont mappées aux colonnes de la table obtenue intégrée à l'application.

Pour obtenir des informations conceptuelles, veuillez consulter Configuration de l'entrée de l'application. Pour connaître les restrictions sur les sources de données que vous pouvez configurer, veuillez consulter Restrictions.

Cette opération exige des autorisations pour exécuter l'action kinesisanalytics:AddApplicationOutput.

Syntaxe de la requête

{
   "ApplicationName": "string",
   "CurrentApplicationVersionId": number,
   "ReferenceDataSource": { 
      "ReferenceSchema": { 
         "RecordColumns": [ 
            { 
               "Mapping": "string",
               "Name": "string",
               "SqlType": "string"
            }
         ],
         "RecordEncoding": "string",
         "RecordFormat": { 
            "MappingParameters": { 
               "CSVMappingParameters": { 
                  "RecordColumnDelimiter": "string",
                  "RecordRowDelimiter": "string"
               },
               "JSONMappingParameters": { 
                  "RecordRowPath": "string"
               }
            },
            "RecordFormatType": "string"
         }
      },
      "S3ReferenceDataSource": { 
         "BucketARN": "string",
         "FileKey": "string",
         "ReferenceRoleARN": "string"
      },
      "TableName": "string"
   }
}

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

ApplicationName

Nom d'une application existante.

Type : chaîne

Contraintes de longueur : Longueur minimum de 1. Longueur maximale de 128.

Modèle : [a-zA-Z0-9_.-]+

Obligatoire : oui

CurrentApplicationVersionId

Version de l’application pour laquelle vous ajoutez la source de données de référence. Vous pouvez utiliser cette DescribeApplicationopération pour obtenir la version actuelle de l'application. Si la version spécifiée n’est pas la version actuelle, ConcurrentModificationException est renvoyé.

Type : long

Plage valide : valeur minimum de 1. Valeur maximale de 999999999.

Obligatoire : oui

ReferenceDataSource

Source des données de référence pouvant être un objet dans votre compartiment Amazon S3. Amazon Kinesis Analytics lit l'objet et copie les données dans la table intégrée à l'application qui est créée. Vous fournissez un compartiment S3, une clé d'objet et le nom de la table obtenue intégrée à l'application qui est créée. Vous devez également fournir un rôle IAM disposant des autorisations requises qu'Amazon Kinesis Analytics peut endosser pour lire l'objet de votre compartiment S3 en votre nom.

Type : objet ReferenceDataSource

Obligatoire : oui

Éléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

Erreurs

ConcurrentModificationException

Exception envoyée suite à la modification simultanée d’une application. Par exemple, deux personnes tentent de modifier la même application en même temps.

Code d’état HTTP : 400

InvalidArgumentException

La valeur du paramètre d’entrée spécifiée n’est pas valide.

Code d’état HTTP : 400

ResourceInUseException

L’application n’est pas disponible pour cette opération.

Code d’état HTTP : 400

ResourceNotFoundException

L’application spécifiée est introuvable.

Code d’état HTTP : 400

UnsupportedOperationException

La requête a été rejetée car un paramètre spécifié n’est pas pris en charge ou parce qu’une ressource spécifiée n’est pas valide pour cette opération.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :