Mengembangkan aplikasi dengan Amazon QuickSight API - Amazon QuickSight

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengembangkan aplikasi dengan Amazon QuickSight API

Anda dapat mengelola sebagian besar aspek penerapan Anda dengan menggunakan AWS SDKs untuk mengakses API yang disesuaikan dengan bahasa pemrograman atau platform yang Anda gunakan. Untuk informasi selengkapnya, lihat AWS SDKs.

Untuk informasi selengkapnya tentang operasi API, lihat Referensi Amazon QuickSight API.

Sebelum Anda dapat memanggil operasi Amazon QuickSight API, Anda memerlukan quicksight:operation-name izin dalam kebijakan yang dilampirkan pada identitas IAM Anda. Misalnya, untuk meneleponlist-users, Anda memerlukan izinquicksight:ListUsers. Pola yang sama berlaku untuk semua operasi.

Jika Anda tidak yakin apa izin yang diperlukan, Anda dapat mencoba melakukan panggilan. Klien kemudian memberi tahu Anda apa izin yang hilang. Anda dapat menggunakan tanda bintang (*) di bidang Sumber daya kebijakan izin Anda alih-alih menentukan sumber daya eksplisit. Namun, kami menyarankan Anda membatasi setiap izin sebanyak mungkin. Anda dapat membatasi akses pengguna dengan menentukan atau mengecualikan sumber daya dalam kebijakan, menggunakan pengenal Nama Sumber Daya Amazon QuickSight Amazon (ARN) mereka.

Untuk informasi selengkapnya, lihat berikut ini:

Untuk mengambil ARN pengguna atau grup, gunakan operasi pada sumber daya Describe yang relevan. Anda juga dapat menambahkan kondisi di IAM untuk lebih membatasi akses ke API dalam beberapa skenario. Misalnya, saat menambahkan User1Group1, sumber daya utama adalahGroup1, sehingga Anda dapat mengizinkan atau menolak akses ke grup tertentu, tetapi Anda juga dapat menambahkan kondisi dengan menggunakan QuickSight kunci IAM Amazon quicksight:UserName untuk mengizinkan atau mencegah pengguna tertentu ditambahkan ke grup itu.

Berikut ini adalah contoh kebijakan. Ini berarti bahwa penelepon dengan kebijakan ini terlampir, dapat menjalankan CreateGroupMembership operasi pada grup mana pun, asalkan nama pengguna yang mereka tambahkan ke grup tidak. user1 

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

Prosedur berikut menjelaskan cara berinteraksi dengan operasi Amazon QuickSight API melalui AWS CLI. Instruksi berikut telah diuji di Bash tetapi harus identik atau serupa di lingkungan baris perintah lainnya.

  1. Instal AWS SDK di lingkungan Anda. Petunjuk tentang cara melakukannya terletak di sini: Antarmuka baris AWS perintah.

  2. Siapkan identitas dan wilayah AWS CLI Anda menggunakan perintah berikut dan instruksi tindak lanjut. Gunakan kredensil untuk identitas IAM atau peran yang memiliki izin yang tepat. 

    aws configure

  3. Lihat bantuan Amazon QuickSight SDK dengan mengeluarkan perintah berikut: 

    aws quicksight help

  4. Untuk mendapatkan petunjuk terperinci tentang cara menggunakan API, masukkan namanya diikuti dengan bantuan, seperti: 

    aws quicksight list-users help

  5. Sekarang Anda dapat memanggil operasi Amazon QuickSight API. Contoh ini mengembalikan daftar QuickSight pengguna Amazon di akun Anda. 

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

Gunakan prosedur berikut untuk menyiapkan aplikasi Java yang berinteraksi dengan Amazon QuickSight.

  1. Untuk memulai, buat proyek Java di IDE Anda.

  2. Impor Amazon QuickSight SDK ke project baru Anda, misalnya: AWSQuickSightJavaClient-1.11.x.jar

  3. Setelah IDE Anda mengindeks Amazon QuickSight SDK, Anda harus dapat menambahkan baris impor sebagai berikut: 

    import com.amazonaws.services.quicksight.AmazonQuickSight;

    Jika IDE Anda tidak mengenali ini sebagai valid, verifikasi bahwa Anda mengimpor SDK.

  4. Seperti lainnya AWS SDKs, Amazon QuickSight SDK memerlukan dependensi eksternal untuk menjalankan banyak fungsinya. Anda perlu mengunduh dan mengimpornya ke proyek yang sama. Dependensi berikut diperlukan:

  5. Sekarang, Anda siap untuk membuat QuickSight klien Amazon. Anda dapat menggunakan endpoint publik default yang dapat berkomunikasi dengan klien atau Anda dapat mereferensikan titik akhir secara eksplisit. Ada beberapa cara untuk memberikan AWS kredensil Anda. Dalam contoh berikut, kami menyediakan pendekatan langsung dan sederhana. Metode klien berikut digunakan untuk membuat semua panggilan API yang mengikuti:

    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. Sekarang, kita dapat menggunakan klien di atas untuk mencantumkan semua pengguna di QuickSight akun Amazon kita.

    catatan

    Anda harus memberikan ID AWS akun yang Anda gunakan untuk berlangganan Amazon QuickSight. Ini harus sesuai dengan ID AWS akun identitas pemanggil. Panggilan lintas akun tidak didukung saat ini. Selanjutnya, parameter yang diperlukan namespace harus selalu diatur kedefault. 

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

  7. Untuk melihat daftar semua kemungkinan operasi API dan objek permintaan yang mereka gunakan, Anda dapat mengklik Ctrl pada objek klien di IDE Anda untuk melihat antarmuka Amazon. QuickSight Atau, temukan di dalam com.amazonaws.services.quicksight paket di file Amazon QuickSight JavaClient JAR.

JavaScript (Node.js) SDK

Gunakan prosedur berikut untuk berinteraksi dengan Amazon QuickSight menggunakan Node.js.

  1. Siapkan lingkungan node Anda menggunakan perintah berikut:

    • npm install aws-sdk

    • npm install aws4

    • npm install request

    • npm install url

  2. Untuk informasi tentang mengonfigurasi Node.js dengan AWS SDK dan menyetel kredensialnya, lihat-> Panduan Pengembang AWS SDK untuk JavaScript untuk SDK v2.

  3. Gunakan contoh kode berikut untuk menguji pengaturan Anda. HTTPS diperlukan. Sampel menampilkan daftar lengkap QuickSight operasi Amazon bersama dengan parameter permintaan URL mereka, diikuti oleh daftar QuickSight pengguna Amazon di akun Anda.

    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

Gunakan prosedur berikut untuk membuat botocore paket yang dibuat khusus untuk berinteraksi dengan Amazon QuickSight.

  1. Buat file kredensial di AWS direktori untuk lingkungan Anda. Dalam Linux/Mac-based environment, that file is called ~/.aws/credentials dan terlihat seperti ini:

    [default]
aws_access_key_id = Your_IAM_access_key
aws_secret_access_key = Your_IAM_secret_key

  2. Buka zip folderbotocore-1.12.10. Ubah direktori menjadi botocore-1.12.10 dan masukkan lingkungan interpreter Python3.

  3. Tanggapan kembali sebagai objek kamus. Mereka masing-masing memiliki ResponseMetadata entri yang berisi status permintaan IDs dan respons. Entri lain didasarkan pada jenis operasi yang Anda jalankan.

  4. Contoh berikut adalah contoh aplikasi yang pertama kali membuat, menghapus, dan mencantumkan grup. Kemudian, daftar pengguna di akun Quicksight:

    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

Gunakan prosedur berikut untuk berinteraksi dengan Amazon QuickSight menggunakan C#.NET. Contoh ini dibuat di Microsoft Visual untuk Mac; instruksinya dapat sedikit berbeda berdasarkan IDE dan platform Anda. Namun, mereka harus serupa.

  1. Unzip nuget.zip file ke dalam folder bernamanuget.

  2. Buat proyek aplikasi Konsol baru di Visual Studio.

  3. Di bawah solusi Anda, cari Dependensi aplikasi, lalu buka konteksnya (menu klik kanan dan pilih Tambahkan Paket.

  4. Dalam daftar sumber, pilih Konfigurasi Sumber.

  5. Pilih Tambah, dan beri nama sumbernyaQuickSightSDK. Browse ke nuget folder dan pilih Add Source.

  6. Pilih OKE. Kemudian, dengan QuickSightSDK dipilih, pilih ketiga QuickSight paket Amazon:

    • AWSSDK.QuickSight

    • AWSSDK.Extensions.NETCore.Setup

    • AWSSDK.Extensions.CognitoAuthentication

  7. Klik Add Package.

  8. Salin dan tempel contoh aplikasi berikut ke editor aplikasi konsol Anda.

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