Entwicklung von Anwendungen mit der Amazon QuickSight API

Installieren Sie AWS das SDK in Ihrer Umgebung. Anweisungen dazu finden Sie hier: AWS Befehlszeilenschnittstelle.

Richten Sie Ihre AWS CLI-Identität und Region mithilfe der folgenden Befehls- und Folgeanweisungen ein. Verwenden Sie die Anmeldeinformationen für eine IAM-Identität oder -Rolle, die über die erforderlichen Berechtigungen verfügt.

aws configure

Sehen Sie sich die Amazon QuickSight SDK-Hilfe an, indem Sie den folgenden Befehl eingeben:

aws quicksight help

Detaillierte Anweisungen zur Verwendung einer API können Sie anzeigen, indem Sie den Namen der API eingeben, gefolgt von „help“:

aws quicksight list-users help

Jetzt können Sie eine QuickSight Amazon-API-Operation aufrufen. In diesem Beispiel wird eine Liste der QuickSight Amazon-Benutzer in Ihrem Konto zurückgegeben.

aws quicksight list-users --aws-account-id aws-account-id --namespace default --region us-east-1

Erstellen Sie zunächst ein Java-Projekt in der IDE.

Importieren Sie das Amazon QuickSight SDK in Ihr neues Projekt, zum Beispiel: AWSQuickSightJavaClient-1.11.x.jar

Sobald Ihre IDE das Amazon QuickSight SDK indexiert hat, sollten Sie in der Lage sein, eine Importzeile wie folgt hinzuzufügen:

import com.amazonaws.services.quicksight.AmazonQuickSight;

Wenn die IDE dieses nicht als gültig erkennt, müssen Sie verifizieren, dass das SDK importiert wurde.

Wie andere auch AWS SDKs benötigt Amazon QuickSight SDK externe Abhängigkeiten, um viele seiner Funktionen auszuführen. Sie müssen diese herunterladen und in dasselbe Projekt importieren. Die folgenden Anhängigkeiten sind erforderlich:

Jetzt sind Sie bereit, einen QuickSight Amazon-Client zu erstellen. Sie können einen öffentlichen Standardendpunkt verwenden, mit dem der Client kommunizieren kann. Alternativ können Sie explizit auf den Endpunkt verweisen. Es gibt mehrere Möglichkeiten, Ihre AWS Anmeldeinformationen anzugeben. Das folgende Beispiel basiert auf einem direkten und einfachen Ansatz. Die folgende Client-Methode wird verwendet, um alle folgenden API-Aufrufe durchzuführen:

private static AmazonQuickSight getClient() {
	final AWSCredentialsProvider credsProvider = new AWSCredentialsProvider() {
	@Override
	public AWSCredentials getCredentials() {
	// provide actual IAM access key and secret key here
	return new BasicAWSCredentials("access-key", "secret-key");
	}
	
	@Override
	public void refresh() {}
	};
	
	return AmazonQuickSightClientBuilder
	.standard()
	.withRegion(Regions.US_EAST_1.getName())
	.withCredentials(credsProvider)
	.build();
	}

Jetzt können wir den obigen Client verwenden, um alle Benutzer in unserem QuickSight Amazon-Konto aufzulisten.

getClient().listUsers(new ListUsersRequest()
        .withAwsAccountId("relevant_AWS_account_ID")
        .withNamespace("default"))
        .getUserList().forEach(user -> {
            System.out.println(user.getArn());
        });

Um eine Liste aller möglichen API-Operationen und der von ihnen verwendeten Anforderungsobjekte zu sehen, können Sie in Ihrer IDE bei gedrückter Strg-Taste auf das Client-Objekt klicken, um die QuickSight Amazon-Schnittstelle aufzurufen. Alternativ finden Sie es im com.amazonaws.services.quicksight Paket in der QuickSight JavaClient Amazon-JAR-Datei.

Richten Sie die Knotenumgebung mit den folgenden Befehlen ein:

Informationen zur Konfiguration von Node.js mit AWS SDK und zur Einstellung Ihrer Anmeldeinformationen finden Sie unter--> im AWS SDK für JavaScript Entwicklerhandbuch für SDK v2.

Verwenden Sie das folgende Code-Beispiel zum Testen der Konfiguration. HTTPS ist erforderlich. Das Beispiel zeigt eine vollständige Liste der QuickSight Amazon-Operationen zusammen mit ihren URL-Anforderungsparametern, gefolgt von einer Liste der QuickSight Amazon-Benutzer in Ihrem Konto.

const AWS = require('aws-sdk');
const https = require('https');

var quicksight = new AWS.Service({
    apiConfig: require('./quicksight-2018-04-01.min.json'),
    region: 'us-east-1',
});

console.log(quicksight.config.apiConfig.operations);

quicksight.listUsers({
    // Enter your actual AWS account ID
    'AwsAccountId': 'relevant_AWS_account_ID', 
    'Namespace': 'default',
}, function(err, data) {
    console.log('---');
    console.log('Errors: ');
    console.log(err);
    console.log('---');
    console.log('Response: ');
    console.log(data);
});

Erstellen Sie eine Anmeldeinformationsdatei im AWS Verzeichnis für Ihre Umgebung. In einem Linux/Mac-based environment, that file is called ~/.aws/credentials und sieht so aus:

[default]
aws_access_key_id = Your_IAM_access_key
aws_secret_access_key = Your_IAM_secret_key

Entpacken Sie den Ordner botocore-1.12.10. Ändern Sie das Verzeichnis in botocore-1.12.10 und rufen Sie die Python3-Interpreter-Umgebung auf.

Antworten werden als Dictionary-Objekt zurückgegeben. Sie haben jeweils einen ResponseMetadata Eintrag, der den Anfrage IDs - und den Antwortstatus enthält. Andere Einträge basieren auf dem Typ der auszuführenden Operation.

Das folgende Beispiel ist eine Beispielanwendung, die zunächst Gruppen erstellt, löscht und auflistet. Anschließend werden Benutzer in einem Quicksight-Konto aufgelistet:

import botocore.session
default_namespace = 'default'
account_id = 'relevant_AWS_Account'

session = botocore.session.get_session()
client = session.create_client("quicksight", region_name='us-east-1')

print('Creating three groups: ')
client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1')
client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2')
client.create_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3')

print('Retrieving the groups and listing them: ')
response = client.list_groups(AwsAccountId = account_id, Namespace=default_namespace)
for group in response['GroupList']:
    print(group)

print('Deleting our groups: ')
client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup1')
client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup2')
client.delete_group(AwsAccountId = account_id, Namespace=default_namespace, GroupName='MyGroup3')

response = client.list_users(AwsAccountId = account_id, Namespace=default_namespace)
for user in response['UserList']:
    print(user)

Extrahieren Sie die Datei nuget.zip in einen Ordner namens nuget.

Erstellen Sie ein neues Konsolenanwendung-Projekt in Visual Studio.

Suchen Sie in der Lösung die App Abhängigkeiten, öffnen Sie dann das Kontextmenü und wählen Sie Pakete hinzufügen.

Wählen Sie in der Liste der Quellen Quellen konfigurieren.

Wählen Sie Hinzufügen und weisen Sie der Quelle den Namen QuickSightSDK zu. Navigieren Sie zum Ordner nuget und wählen Sie Quelle hinzufügen.

Wählen Sie OK aus. Wählen Sie dann bei QuickSightSDK Auswahl alle drei QuickSight Amazon-Pakete aus:

Klicken Sie auf Paket hinzufügen.

Kopieren Sie die folgende Beispielanwendung und fügen Sie sie in den Konsolen-Anwendungseditor ein.

using System;
using Amazon.QuickSight.Model;
using Amazon.QuickSight;

namespace DotNetQuickSightSDKTest
{
    class Program
    {
        private static readonly string AccessKey = "insert_your_access_key";
        private static readonly string SecretAccessKey = "insert_your_secret_key";
        private static readonly string AccountID = "AWS_account_ID";
        private static readonly string Namespace = "default";  // leave this as default

        static void Main(string[] args)
        {
            var client = new AmazonQuickSightClient(
                AccessKey,
                SecretAccessKey, 
                Amazon.RegionEndpoint.USEast1);

            var listUsersRequest = new ListUsersRequest
            {
                AwsAccountId = AccountID,
                Namespace = Namespace
            };

            client.ListUsersAsync(listUsersRequest).Result.UserList.ForEach(
                user => Console.WriteLine(user.Arn)
            );

            var listGroupsRequest = new ListGroupsRequest
            {
                AwsAccountId = AccountID,
                Namespace = Namespace
            };

            client.ListGroupsAsync(listGroupsRequest).Result.GroupList.ForEach(
                group => Console.WriteLine(group.Arn)
            );
        }
    }
}