

# Perfiles de uso
<a name="aws-glue-api-usage-profiles"></a>

La API de perfiles de uso describe los tipos de datos y la API relacionados con la creación, actualización o visualización de los perfiles de uso en AWS Glue.

## Tipos de datos
<a name="aws-glue-api-usage-profiles-objects"></a>
+ [Estructura ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration)
+ [Estructura ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject)
+ [Estructura UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition)

## Estructura ProfileConfiguration
<a name="aws-glue-api-usage-profiles-ProfileConfiguration"></a>

Especifica los valores de trabajo y sesión que un administrador configura en un perfil de uso de AWS Glue.

**Campos**
+ `SessionConfiguration`: matriz de mapas de pares clave-valor.

  Cada clave es una 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Cada valor es un objeto A [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject).

  Un mapa de clave-valor de los parámetros de configuración de las sesiones de AWS Glue. 
+ `JobConfiguration`: matriz de mapas de pares clave-valor.

  Cada clave es una 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Cada valor es un objeto A [ConfigurationObject](#aws-glue-api-usage-profiles-ConfigurationObject).

  Un mapa de clave-valor de los parámetros de configuración de los trabajos de AWS Glue. 

## Estructura ConfigurationObject
<a name="aws-glue-api-usage-profiles-ConfigurationObject"></a>

Especifica los valores que un administrador establece para cada parámetro de trabajo o sesión configurado en un perfil de uso de AWS Glue.

**Campos**
+ `DefaultValue`: 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 #35](aws-glue-api-common.md#regex_35).

  Un valor predeterminado para el parámetro.
+ `AllowedValues`: matriz de cadenas UTF-8.

  Una lista de valores permitidos para el parámetro.
+ `MinValue`: 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 #35](aws-glue-api-common.md#regex_35).

  Un valor mínimo permitido para el parámetro.
+ `MaxValue`: 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 #35](aws-glue-api-common.md#regex_35).

  Un valor máximo permitido para el parámetro.

## Estructura UsageProfileDefinition
<a name="aws-glue-api-usage-profiles-UsageProfileDefinition"></a>

Describe un perfil de uso de AWS Glue.

**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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso.
+ `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Una descripción del perfil de uso.
+ `CreatedOn`: marca temporal.

  La fecha y la hora en que se creó el perfil de uso.
+ `LastModifiedOn`: marca temporal.

  La fecha y la hora en que se modificó el perfil de uso por última vez.

## Operaciones
<a name="aws-glue-api-usage-profiles-actions"></a>
+ [Acción CreateUsageProfile (Python: create\$1usage\$1profile)](#aws-glue-api-usage-profiles-CreateUsageProfile)
+ [Acción GetUsageProfile (Python: get\$1usage\$1profile)](#aws-glue-api-usage-profiles-GetUsageProfile)
+ [Acción UpdateUsageProfile (Python: update\$1usage\$1profile)](#aws-glue-api-usage-profiles-UpdateUsageProfile)
+ [Acción DeleteUsageProfile (Python: delete\$1usage\$1profile)](#aws-glue-api-usage-profiles-DeleteUsageProfile)
+ [Acción ListUsageProfiles (Python: list\$1usage\$1profiles)](#aws-glue-api-usage-profiles-ListUsageProfiles)

## Acción CreateUsageProfile (Python: create\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-CreateUsageProfile"></a>

Crea un perfil de uso de AWS Glue.

**Solicitud**
+ `Name`: *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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso.
+ `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Una descripción del perfil de uso.
+ `Configuration`: *obligatorio:* objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Un objeto `ProfileConfiguration` que especifica los valores de trabajo y sesión del perfil.
+ `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.

  Una lista de etiquetas aplicadas al perfil de uso.

**Respuesta**
+ `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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso que se creó.

**Errores**
+ `InvalidInputException`
+ `InternalServiceException`
+ `AlreadyExistsException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `OperationNotSupportedException`

## Acción GetUsageProfile (Python: get\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-GetUsageProfile"></a>

Recupera información sobre el perfil de uso de AWS Glue especificado.

**Solicitud**
+ `Name`: *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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso que se va a recuperar.

**Respuesta**
+ `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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso.
+ `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Una descripción del perfil de uso.
+ `Configuration`: un objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Un objeto `ProfileConfiguration` que especifica los valores de trabajo y sesión del perfil.
+ `CreatedOn`: marca temporal.

  La fecha y la hora en que se creó el perfil de uso.
+ `LastModifiedOn`: marca temporal.

  La fecha y la hora en que se modificó el perfil de uso por última vez.

**Errores**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## Acción UpdateUsageProfile (Python: update\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-UpdateUsageProfile"></a>

Actualiza un perfil de uso de AWS Glue.

**Solicitud**
+ `Name`: *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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso.
+ `Description`: cadena de descripción de un máximo de 2048 bytes de largo, que coincide con el [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Una descripción del perfil de uso.
+ `Configuration`: *obligatorio:* objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Un objeto `ProfileConfiguration` que especifica los valores de trabajo y sesión del perfil.

**Respuesta**
+ `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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso que se actualizó.

**Errores**
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`
+ `ConcurrentModificationException`

## Acción DeleteUsageProfile (Python: delete\$1usage\$1profile)
<a name="aws-glue-api-usage-profiles-DeleteUsageProfile"></a>

Elimina el perfil de uso de AWS Glue especificado.

**Solicitud**
+ `Name`: *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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  El nombre del perfil de uso que se va a eliminar.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## Acción ListUsageProfiles (Python: list\$1usage\$1profiles)
<a name="aws-glue-api-usage-profiles-ListUsageProfiles"></a>

Enumera todos los perfiles de uso de AWS Glue.

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

  Token de continuación, incluido si se trata de una llamada de continuidad.
+ `MaxResults`: número (entero), mayor que 1 y menor que 200.

  El número máximo de perfiles de uso que se devolverán en una sola respuesta.

**Respuesta**
+ `Profiles`: matriz de objetos [UsageProfileDefinition](#aws-glue-api-usage-profiles-UsageProfileDefinition).

  Una lista de objetos del perfil de uso (`UsageProfileDefinition`).
+ `NextToken`: cadena UTF-8 de 400 000 bytes de largo como máximo.

  Un token de continuación, presente si el segmento de lista actual no es el último.

**Errores**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `OperationNotSupportedException`