API de sesiones interactivas - AWS Glue

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de sesiones interactivas

La API de sesiones interactivas describe la API AWS Glue relacionada con el uso de sesiones interactivas AWS Glue para crear y probar scripts de extracción, transformación y carga (ETL) para la integración de datos.

Tipos de datos

Estructura de sesión

El período en el que se ejecuta un entorno en tiempo de ejecución de Spark remoto.

Campos
  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de la sesión.

  • CreatedOn: marca temporal.

    La fecha y hora en que se creó la sesión.

  • Status: cadena UTF-8 (valores válidos: PROVISIONING | READY | FAILED | TIMEOUT | STOPPING | STOPPED).

    El estado de la sesión.

  • ErrorMessage: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

    El mensaje de error que se muestra durante la sesión.

  • Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

    La descripción de la sesión.

  • Role: cadena UTF-8, con 20 bytes como mínimo o más de 2048 bytes de largo, que coincide con el Custom string pattern #20.

    El nombre o nombre de recurso de Amazon (ARN) del rol de IAM asociado a la sesión.

  • Command: objeto SessionCommand.

    El objeto de comando. Consulte SessionCommand.

  • DefaultArguments: una matriz de asignación de pares de clave-valor, con 75 pares como máximo.

    Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con Custom string pattern #21.

    Cada valor es una cadena UTF-8, con 4096 bytes de largo como máximo, que coincide con URI address multi-line string pattern.

    Una matriz de mapas de pares clave-valor. El máximo es de 75 pares.

  • Connections: objeto ConnectionsList.

    El número de conexiones utilizadas para la sesión.

  • Progress: número (doble).

    El progreso de la ejecución del código de la sesión.

  • MaxCapacity: número (doble).

    El número de unidades de procesamiento de datos (DPU) de AWS Glue que se pueden asignar cuando se ejecute el trabajo. Una DPU es una medida relativa de la potencia de procesamiento que consta de 4 vCPU de capacidad de computación y 16 GB de memoria.

  • SecurityConfiguration: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la SecurityConfiguration estructura que se va a utilizar con la sesión.

  • GlueVersion: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #15.

    La versión de AWS Glue determina las versiones de Apache Spark y Python que admite AWS Glue. El GlueVersion debe ser superior a 2.0.

  • DataAccessId: cadena UTF-8, con 1 byte como mínimo o más de 36 bytes de largo.

    El ID de acceso a datos de la sesión.

  • PartitionId: cadena UTF-8, con 1 byte como mínimo o más de 36 bytes de largo.

    El ID de partición de la sesión.

SessionCommand estructura

El SessionCommand que ejecuta este trabajo.

Campos
  • Name: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Especifica el nombre del SessionCommand. Puede ser “glueetl” o “gluestreaming”.

  • PythonVersion: cadena UTF-8 que coincide con el Custom string pattern #16.

    Especifica la versión de Python. La versión de Python indica la versión admitida para trabajos de tipo Spark.

Estructura de instrucción

La instrucción o solicitud de que se produzca una acción concreta en una sesión.

Campos
  • Id: número (entero).

    El ID de la instrucción.

  • Code: cadena UTF-8.

    El código de ejecución de la instrucción.

  • State: cadena UTF-8 (valores válidos: WAITING | RUNNING | AVAILABLE | CANCELLING | CANCELLED | ERROR).

    El estado mientras se ejecuta la solicitud.

  • Output: objeto StatementOutput.

    El resultado en JSON.

  • Progress: número (doble).

    El progreso de ejecución del código.

  • StartedOn: número (largo).

    La fecha y hora unix en que se inició la definición del trabajo.

  • CompletedOn: número (largo).

    La fecha y hora unix en que se completó la definición del trabajo.

StatementOutput estructura

El resultado de la ejecución de código en formato JSON.

Campos
  • Data: objeto StatementOutputData.

    El resultado de la ejecución de código.

  • ExecutionCount: número (entero).

    El recuento de ejecución del resultado.

  • Status: cadena UTF-8 (valores válidos: WAITING | RUNNING | AVAILABLE | CANCELLING | CANCELLED | ERROR).

    El estado del resultado de ejecución de código.

  • ErrorName: cadena UTF-8.

    El nombre del error en el resultado.

  • ErrorValue: cadena UTF-8.

    El valor de error del resultado.

  • Traceback: matriz de cadenas UTF-8.

    El seguimiento del resultado.

StatementOutputData estructura

El resultado de la ejecución de código en formato JSON.

Campos
  • TextPlain: cadena UTF-8.

    El resultado de la ejecución de código en formato de texto.

Operaciones

CreateSession acción (Python: create_session)

Crea una nueva sesión.

Solicitud

Solicitud para crear una nueva sesión.

  • Id: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de la solicitud de sesión.

  • Description: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el URI address multi-line string pattern.

    La descripción de la sesión.

  • Role: obligatorio: cadena UTF-8, con 20 bytes de largo o más de 2048 bytes de largo, que coincide con el Custom string pattern #20.

    El ARN del rol de IAM

  • Command: obligatorio: objeto SessionCommand.

    El SessionCommand que pone en marcha el trabajo.

  • Timeout: número (entero), como mínimo 1.

    El número de segundos antes de que se agote el tiempo de la solicitud.

  • IdleTimeout: número (entero), como mínimo 1.

    El número de segundos que están inactivos antes de agotar el tiempo de la solicitud.

  • DefaultArguments: una matriz de asignación de pares de clave-valor, con 75 pares como máximo.

    Cada clave es una cadena UTF-8 con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con Custom string pattern #21.

    Cada valor es una cadena UTF-8, con 4096 bytes de largo como máximo, que coincide con URI address multi-line string pattern.

    Una matriz de mapas de pares clave-valor. El máximo es de 75 pares.

  • Connections: objeto ConnectionsList.

    Número de conexiones que se van a utilizar para la sesión.

  • MaxCapacity: número (doble).

    El número de unidades de procesamiento de datos (DPU) de AWS Glue que se pueden asignar cuando se ejecute el trabajo. Una DPU es una medida relativa de la potencia de procesamiento que consta de 4 vCPU de capacidad de computación y 16 GB de memoria.

  • NumberOfWorkers: número (entero).

    El número de trabajadores de una WorkerType definida para usar para la sesión.

  • WorkerType: cadena UTF-8 (valores válidos: Standard="" | G.1X="" | G.2X="" | G.025X="").

    El tipo de empleado predefinido que se asigna para uso en la sesión. Admite un valor de Standard, G.1X, G.2X. o G.025X.

    • Para el tipo de proceso de trabajo Standard, cada proceso de trabajo proporciona 4 vCPU, 16 GB de memoria y un disco de 50 GB y 2 ejecutores por proceso de trabajo.

    • Para el tipo de proceso de trabajo G.1X, cada proceso de trabajo se asocia a 1 DPU (4 vCPU, 16 GB de memoria, disco de 64 GB) y proporciona 1 ejecutor por proceso de trabajo. Le recomendamos este tipo de proceso de trabajo para trabajos con un uso intensivo de la memoria.

    • Para el tipo de proceso de trabajo G.2X, cada proceso de trabajo se asocia a 2 DPU (8 vCPU, 32 GB de memoria, disco de 128 GB) y proporciona 1 ejecutor por proceso de trabajo. Le recomendamos este tipo de proceso de trabajo para trabajos con un uso intensivo de la memoria.

    • Para el tipo de proceso de trabajo G.025X, cada empleado se asigna a 0.25 DPU (2 vCPU, 4 GB de memoria, disco de 64 GB) y proporciona 1 ejecutor por proceso de trabajo. Le recomendamos este tipo de proceso de trabajo para trabajos de streaming de bajo volumen. Este tipo de proceso de trabajo solo está disponible para trabajos de streaming con la versión 3.0 de AWS Glue.

  • SecurityConfiguration: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El nombre de la SecurityConfiguration estructura que se va a utilizar con la sesión

  • GlueVersion: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Custom string pattern #15.

    La versión de AWS Glue determina las versiones de Apache Spark y Python que admite AWS Glue. El GlueVersion debe ser superior a 2.0.

  • DataAccessId: cadena UTF-8, con 1 byte como mínimo o más de 36 bytes de largo.

    El ID de acceso a datos de la sesión.

  • PartitionId: cadena UTF-8, con 1 byte como mínimo o más de 36 bytes de largo.

    El ID de partición de la sesión.

  • Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.

    Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.

    Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.

    El mapa de pares de valor de clave (etiquetas) pertenecientes a la sesión.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
Errores
  • AccessDeniedException

  • IdempotentParameterMismatchException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • ValidationException

  • AlreadyExistsException

  • ResourceNumberLimitExceededException

StopSession acción (Python: stop_session)

Detiene la sesión.

Solicitud
  • Id: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de la sesión que se va a detener.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Arroja el ID de la sesión detenida.

Errores
  • AccessDeniedException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • IllegalSessionStateException

  • ConcurrentModificationException

DeleteSession acción (Python: deletete_session)

Elimina la sesión.

Solicitud
  • Id: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de la sesión que se va a eliminar.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El nombre del origen de la solicitud de eliminación de sesión.

Respuesta
  • Id: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Arroja el ID de la sesión eliminada.

Errores
  • AccessDeniedException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • IllegalSessionStateException

  • ConcurrentModificationException

GetSession acción (Python: get_session)

Recupera la sesión.

Solicitud
  • Id: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    Token de continuación si todavía no se arrojaron todas las instrucciones.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
  • Session: objeto Session (Sesión).

    Se recupera el objeto de la sesión en la respuesta.

Errores
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

ListSessions acción (Python: list_sessions)

Recupere una lista de sesiones.

Solicitud
  • NextToken: cadena UTF-8 de 400 000 bytes de largo como máximo.

    El token para el próximo conjunto de resultados o nulo si no hay más resultados.

  • MaxResults: número (entero) que no es inferior a 1 ni es superior a 1000.

    El número máximo de resultados.

  • Tags: matriz de mapas de pares de clave-valor, con 50 pares como máximo.

    Cada clave es una cadena UTF-8 con una longitud de entre 1 y 128 bytes.

    Cada valor es una cadena UTF-8 que no tiene más de 256 bytes de largo.

    Etiquetas pertenecientes a la sesión.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
  • Ids: matriz de cadenas UTF-8.

    Arroja el ID de la sesión.

  • Sessions: matriz de objetos Session (Sesión).

    Arroja el objeto de la sesión.

  • NextToken: cadena UTF-8 de 400 000 bytes de largo como máximo.

    El token para el próximo conjunto de resultados o nulo si no hay más resultados.

Errores
  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

RunStatement acción (Python: run_statement)

Pone en marcha la instrucción.

Solicitud
  • SessionId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de sesión de la instrucción que se ejecutará.

  • Code: obligatorio: cadena UTF-8, de 68 000 bytes de largo como máximo.

    El código de instrucción que se pondrá en marcha.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
  • Id: número (entero).

    Arroja el ID de la instrucción que se puso en marcha.

Errores
  • EntityNotFoundException

  • AccessDeniedException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • ValidationException

  • ResourceNumberLimitExceededException

  • IllegalSessionStateException

CancelStatement acción (Python: cancel_statement)

Cancela la instrucción.

Solicitud
  • SessionId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de sesión de la instrucción que se va a cancelar.

  • IdObligatorio: número (entero).

    El ID de la instrucción que se va a cancelar.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud de cancelación de la instrucción.

Respuesta
  • Sin parámetros de respuesta.

Errores
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • IllegalSessionStateException

GetStatement acción (Python: get_statement)

Recupera la instrucción.

Solicitud
  • SessionId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de sesión de la instrucción.

  • IdObligatorio: número (entero).

    El ID de la instrucción.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud.

Respuesta
  • Statement: objeto Statement.

    Arroja la instrucción.

Errores
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • IllegalSessionStateException

ListStatements acción (Python: list_statement)

Muestra las instrucciones de la sesión.

Solicitud
  • SessionId: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

    El ID de sesión de las instrucciones.

  • RequestOrigin: cadena UTF-8, con 1 byte de largo como mínimo y 128 bytes de largo como máximo, que coincide con el Custom string pattern #21.

    El origen de la solicitud de enumeración de instrucciones.

  • NextToken: cadena UTF-8 de 400 000 bytes de largo como máximo.

    Token de continuación si se trata de una llamada de continuidad.

Respuesta
  • Statements: matriz de objetos Statement.

    Arroja la lista de instrucciones.

  • NextToken: cadena UTF-8 de 400 000 bytes de largo como máximo.

    Token de continuación si todavía no se arrojaron todas las instrucciones.

Errores
  • AccessDeniedException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • IllegalSessionStateException