Entwicklung von Anwendungen mit der Amazon Quick Sight API - Amazon Quick Suite

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Entwicklung von Anwendungen mit der Amazon Quick Sight API

Sie können die meisten Aspekte Ihrer Bereitstellung verwalten, indem Sie die verwenden, AWS SDKs um auf eine API zuzugreifen, die auf die von Ihnen verwendete Programmiersprache oder Plattform zugeschnitten ist. Weitere Informationen finden Sie unter AWS SDKs.

Weitere Informationen zu den API-Vorgängen finden Sie unter Amazon Quick Sight API-Referenz.

Bevor Sie die Amazon Quick Sight-API-Operationen aufrufen können, benötigen Sie die quicksight:operation-name Genehmigung in einer mit Ihrer IAM-Identität verknüpften Richtlinie. Um beispielsweise list-users aufzurufen, benötigen Sie die Berechtigung quicksight:ListUsers. Dieses Muster gilt für alle Operationen.

Wenn Sie sich nicht sicher sind, welche Berechtigungen erforderlich sind, können Sie versuchen, einen Anruf zu tätigen. Der Kunde teilt Ihnen dann mit, welche Erlaubnis fehlt. Sie können ein Sternchen (*) im Feld Ressource Ihrer Berechtigungsrichtlinie verwenden, anstatt explizite Ressourcen anzugeben. Wir empfehlen jedoch, dass Sie die einzelnen Berechtigungen möglichst einschränken. Sie können den Benutzerzugriff einschränken, indem Sie Ressourcen in der Richtlinie angeben oder ausschließen und dabei deren Amazon Quick Sight Amazon Resource Name (ARN) -Kennung verwenden.

Weitere Informationen finden Sie hier:

Verwenden Sie zum Abrufen eines Benutzers oder einer Gruppe die Operation Describe für die jeweilige Ressource. Sie können auch Bedingungen in IAM hinzufügen, um den Zugriff auf eine API in bestimmten Szenarien weiter zu beschränken. Wenn Sie beispielsweise User1 zu Group1 hinzufügen, ist die HauptressourceGroup1, sodass Sie bestimmten Gruppen den Zugriff gewähren oder verweigern können, aber Sie können auch eine Bedingung hinzufügen, indem Sie den IAM Amazon Quick Sight-Schlüssel verwenden, quicksight:UserName um zu erlauben oder zu verhindern, dass bestimmte Benutzer zu dieser Gruppe hinzugefügt werden.

Es folgt eine Beispielrichtlinie. Dies bedeutet, dass ein Aufrufer, an den diese Richtlinie angehängt ist, die Operation CreateGroupMembership für jede Gruppe aufrufen kann, sofern der der Gruppe hinzugefügte Benutzername nicht user1 lautet. 

{
    "Effect": "Allow",
    "Action": "quicksight:CreateGroupMembership",
    "Resource": "arn:aws:quicksight:us-east-1:aws-account-id:group/default/*",
    "Condition": {
        "StringNotEquals": {
            "quicksight:UserName": "user1"
        }
    }
}
AWS CLI

Das folgende Verfahren erklärt, wie Sie mit Amazon Quick Sight API-Vorgängen über die AWS CLI interagieren. Die folgenden Anweisungen wurden in Bash getestet, sollten jedoch für andere Befehlszeilenumgebungen identisch oder zumindest ähnlich sein.

  1. Installieren Sie AWS das SDK in Ihrer Umgebung. Anweisungen hierzu finden Sie unter AWS -Befehlszeilenschnittstelle.

  2. 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

  3. Sehen Sie sich die Amazon Quick Sight SDK-Hilfe an, indem Sie den folgenden Befehl eingeben: 

    aws quicksight help

  4. 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

  5. Jetzt können Sie einen Amazon Quick Sight API-Vorgang aufrufen. In diesem Beispiel wird eine Liste der Amazon Quick Sight-Benutzer in Ihrem Konto zurückgegeben. 

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

Gehen Sie wie folgt vor, um eine Java-App einzurichten, die mit Amazon Quick Sight interagiert.

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

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

  3. Sobald Ihre IDE das Amazon Quick Sight 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.

  4. Wie andere auch AWS SDKs benötigt das Amazon Quick Sight SDK externe Abhängigkeiten, um viele seiner Funktionen ausführen zu können. Sie müssen diese herunterladen und in dasselbe Projekt importieren. Die folgenden Anhängigkeiten sind erforderlich:

  5. Jetzt sind Sie bereit, einen Amazon Quick Sight-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();
	}

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

    Anmerkung

    Sie müssen die AWS Konto-ID angeben, mit der Sie Amazon Quick Sight abonniert haben. Diese muss mit der AWS Konto-ID der Identität des Anrufers übereinstimmen. Kontoübergreifende Aufrufe werden derzeit nicht unterstützt. Außerdem namespace sollte der erforderliche Parameter immer auf gesetzt seindefault. 

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

  7. 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 Amazon Quick Sight-Oberfläche aufzurufen. Alternativ finden Sie es im com.amazonaws.services.quicksight Paket in der Amazon Quick Sight JavaClient JAR-Datei.

JavaScript (Node.js) SDK

Gehen Sie wie folgt vor, um mithilfe von Node.js mit Amazon Quick Sight zu interagieren.

  1. Richten Sie die Knotenumgebung mit den folgenden Befehlen ein:

    • npm install aws-sdk

    • npm install aws4

    • npm install request

    • npm install url

  2. 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.

  3. Verwenden Sie das folgende Code-Beispiel zum Testen der Konfiguration. HTTPS ist erforderlich. Das Beispiel zeigt eine vollständige Liste der Amazon Quick Sight-Operationen zusammen mit ihren URL-Anforderungsparametern, gefolgt von einer Liste der Amazon Quick Sight-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);
});
Python3 SDK

Gehen Sie wie folgt vor, um ein benutzerdefiniertes botocore Paket für die Interaktion mit Amazon Quick Sight zu erstellen.

  1. 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

  2. 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.

  3. 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.

  4. 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)
.NET/C# SDK

Gehen Sie wie folgt vor, um mithilfe von C#.NET mit Amazon Quick Sight zu interagieren. Dieses Beispiel wurde mit Microsoft Visual für Mac erstellt. Die Anweisungen können in Abhängigkeit von IDE und Plattform geringfügig abweichen. Sie sollten jedoch ähnlich sein.

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

  2. Erstellen Sie ein neues Konsolenanwendung-Projekt in Visual Studio.

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

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

  5. 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.

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

    • AWSSDK.QuickSight

    • AWSSDK.Extensions.NETCore.Setup

    • AWSSDK.Extensions.CognitoAuthentication

  7. Klicken Sie auf Paket hinzufügen.

  8. 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)
            );
        }
    }
}