Desarrollo de aplicaciones con la API Amazon Quick Sight

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

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

aws configure

Consulte la ayuda del SDK de Amazon Quick Sight emitiendo 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 Quick Sight. En este ejemplo, se devuelve una lista de los usuarios de Amazon Quick Sight de su 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 Quick Sight a su nuevo proyecto, por ejemplo: AWSQuickSightJavaClient-1.11.x.jar

Una vez que su IDE indexe el SDK de Amazon Quick Sight, debería poder añadir una línea de importación de la siguiente manera:

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 AWS SDKs, el SDK de Amazon Quick Sight 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 está listo para crear un cliente de Amazon Quick Sight. 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 formas de proporcionar sus AWS credenciales. 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 usar el cliente anterior para enumerar todos los usuarios de nuestra cuenta de Amazon Quick Sight.

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 operaciones de API posibles y los objetos de solicitud que utilizan, puede hacer clic con la tecla Ctrl en el objeto de cliente de su IDE para ver la interfaz de Amazon Quick Sight. Como alternativa, búsquelo dentro del com.amazonaws.services.quicksight paquete en el archivo JavaClient JAR de Amazon Quick Sight.

Configure el entorno del nodo con los comandos siguientes:

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

Utilice el ejemplo de código siguiente para comprobar la configuración. HTTPS es obligatorio. El ejemplo muestra una lista completa de las operaciones de Amazon Quick Sight junto con sus parámetros de solicitud de URL, seguida de una lista de los usuarios de Amazon Quick Sight de su 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 AWS directorio de su entorno. En un Linux/Mac-based environment, that file is called ~/.aws/credentials y tiene este aspecto:

[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 uno de ellos tiene una ResponseMetadata entrada que contiene el estado de la solicitud IDs y 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 OK (Aceptar). Luego, con la QuickSightSDK opción seleccionada, selecciona los tres paquetes de Amazon Quick Sight:

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