Desarrollo de aplicaciones con la API de Amazon QuickSight

Instale el SDK de AWS en su entorno. Encontrará instrucciones para hacerlo aquí: Interfaz de línea de comandos de AWS.

Configure la identidad y la región de la CLI de AWS con el comando siguiente y siga las instrucciones. Utilice las credenciales de una identidad o rol de IAM que tenga los permisos adecuados.

aws configure

Para consultar la ayuda del SDK de Amazon QuickSight, ejecute el siguiente comando:

aws quicksight help

Para obtener instrucciones detalladas sobre el uso de una API, escriba su nombre seguido de “help”, del siguiente modo:

aws quicksight list-users help

Ahora puede llamar a una operación de la API de Amazon QuickSight. En este ejemplo se obtiene una lista con los usuarios de Amazon QuickSight de la cuenta.

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

Para empezar, cree un proyecto de Java en el IDE.

Importe el SDK de Amazon QuickSight en el nuevo proyecto, por ejemplo: AWSQuickSightJavaClient-1.11.x.jar

Una vez que el IDE indexe el SDK de Amazon QuickSight, debería poder añadir una línea de importación, de este modo:

import com.amazonaws.services.quicksight.AmazonQuickSight;

Si el IDE no lo reconoce como válido, compruebe que ha importado el SDK.

Al igual que otros SDK de AWS, el SDK de Amazon QuickSight requiere dependencias externas para realizar muchas de sus funciones. Es necesario descargarlas e importarlas en el mismo proyecto. Se requieren las dependencias siguientes:

Ahora ya puede crear un cliente de Amazon QuickSight. Puede utilizar punto de enlace público predeterminado con el que el cliente pueda comunicar o indicar el punto de enlace de forma explícita. Existen varias maneras de proporcionar las credenciales de AWS. En el siguiente ejemplo ofrecemos un método sencillo y directo. En el método de cliente siguiente se utiliza para realizar todas las llamadas a la API subsiguientes:

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

Ahora podemos utilizar el cliente anterior para obtener una lista de todos los usuarios de nuestra de Amazon QuickSight.

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

Para ver una lista de todas las posibles operaciones de API y los objetos de solicitud que utilizan, haga CTRL-clic en el objeto cliente en el IDE para ver la interfaz de Amazon QuickSight. También puede encontrarla en el paquete com.amazonaws.services.quicksight contenido en el archivo JAR del cliente Java para Amazon QuickSight.

Configure el entorno del nodo con los comandos siguientes:

Para obtener información sobre cómo configurar Node.js con el SDK de AWS y establecer sus credenciales, consulte la Guía para desarrolladores de AWS SDK para JavaScript para SDK v2.

Utilice el ejemplo de código siguiente para comprobar la configuración. HTTPS es obligatorio. El ejemplo muestra una lista completa de operaciones de Amazon QuickSight junto con sus parámetros de solicitud URL, seguida de una lista de usuarios de Amazon QuickSight en la cuenta.

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

Cree un archivo de credenciales en el directorio de AWS para el entorno. En un entorno basado en Linux/Mac, el archivo se denomina ~/.aws/credentials y es similar al siguiente:

[default]
aws_access_key_id = Your_IAM_access_key
aws_secret_access_key = Your_IAM_secret_key

Descomprima la carpeta botocore-1.12.10. Cambie el directorio a botocore-1.12.10 y escriba el nombre del entorno del intérprete Python3.

Las respuestas volverán como un objeto de diccionario. Cada una tendrá una entrada ResponseMetadata con los ID de solicitud y el estado de la respuesta. Las demás entradas dependen del tipo de operación que ejecute.

El ejemplo siguiente es una aplicación de muestra que primero crea, elimina y muestra grupos. A continuación muestra una lista de los usuarios de una cuenta de 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)

Descomprima el archivo nuget.zip en una carpeta llamada nuget.

Cree un nuevo proyecto Aplicación de consola en Visual Studio.

Dentro de la solución, busque las Dependencias de la aplicación y, a continuación, abra el menú contextual (clic con el botón derecho) y elija Agregar paquetes.

En la lista de orígenes, elija Configurar orígenes.

Elija Agregar y asigne al origen el nombre QuickSightSDK. Navegue hasta la carpeta nuget y elija Agregar origen.

Seleccione Aceptar. A continuación, con QuickSightSDK seleccionado, seleccione los tres paquetes de Amazon QuickSight:

Haga clic en Agregar paquete.

Copie y pegue la siguiente aplicación de ejemplo en el editor de aplicaciones de la consola.

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