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

A API de perfis de uso descreve os tipos de dados e API relacionados à criação, atualização ou exibição de fluxos de trabalho no AWS Glue.

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

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

Especifica os valores de trabalho e sessão que um administrador configura em um perfil de uso do AWS Glue.

**Campos**
+ `SessionConfiguration` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

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

  Um mapa de chave-valor de configuração para sessões do AWS Glue. 
+ `JobConfiguration` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

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

  Um mapa de chave-valor de configuração para trabalhos do AWS Glue. 

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

Especifica os valores que um administrador define para cada parâmetro de trabalho ou sessão configurado em um perfil de uso do AWS Glue.

**Campos**
+ `DefaultValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor padrão para o parâmetro.
+ `AllowedValues` – Uma matriz de strings UTF-8.

  Uma lista dos valores permitidos para o parâmetro.
+ `MinValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor mínimo permitido para o parâmetro.
+ `MaxValue`: string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento e correspondente a [Custom string pattern #35](aws-glue-api-common.md#regex_35).

  Um valor máximo permitido para o parâmetro.

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

Descreve um perfil de uso do AWS Glue.

**Campos**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil do usuário.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do perfil de uso.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi criado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi modificado pela última vez.

## Operações
<a name="aws-glue-api-usage-profiles-actions"></a>
+ [Ação CreateUsageProfile (Python: create\_usage\_profile)](#aws-glue-api-usage-profiles-CreateUsageProfile)
+ [Ação GetUsageProfile (Python: get\_usage\_profile)](#aws-glue-api-usage-profiles-GetUsageProfile)
+ [Ação UpdateUsageProfile (Python: update\_usage\_profile)](#aws-glue-api-usage-profiles-UpdateUsageProfile)
+ [Ação DeleteUsageProfile (Python: delete\_usage\_profile)](#aws-glue-api-usage-profiles-DeleteUsageProfile)
+ [Ação ListUsageProfiles (Python: list\_usage\_profiles)](#aws-glue-api-usage-profiles-ListUsageProfiles)

## Ação CreateUsageProfile (Python: create\_usage\_profile)
<a name="aws-glue-api-usage-profiles-CreateUsageProfile"></a>

Cria um perfil de uso do AWS Glue.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil do usuário.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do perfil de uso.
+ `Configuration` – *Obrigatório:* um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.
+ `Tags`: uma matriz de mapa dos pares de chave-valor, não mais que 50 pares.

  Cada chave é uma string UTF-8, com comprimento entre 1 e 128 bytes.

  Cada valor é uma string UTF-8, inferior a 256 bytes de comprimento.

  Uma lista de tags aplicadas ao perfil de uso.

**Resposta**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil de uso que foi criado.

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

## Ação GetUsageProfile (Python: get\_usage\_profile)
<a name="aws-glue-api-usage-profiles-GetUsageProfile"></a>

Recupera informações sobre o perfil de uso do AWS Glue especificado.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil de uso a ser recuperado.

**Resposta**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil do usuário.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do perfil de uso.
+ `Configuration` – Um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.
+ `CreatedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi criado.
+ `LastModifiedOn` – Timestamp.

  A data e a hora em que o perfil de uso foi modificado pela última vez.

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

## Ação UpdateUsageProfile (Python: update\_usage\_profile)
<a name="aws-glue-api-usage-profiles-UpdateUsageProfile"></a>

Atualiza um perfil de uso do AWS Glue.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil do usuário.
+ `Description`: string de descrição com no máximo 2.048 bytes de comprimento e correspondente a [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).

  Uma descrição do perfil de uso.
+ `Configuration` – *Obrigatório:* um objeto [ProfileConfiguration](#aws-glue-api-usage-profiles-ProfileConfiguration).

  Um objeto `ProfileConfiguration` que especifica os valores do trabalho e da sessão para o perfil.

**Resposta**
+ `Name` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil de uso que foi atualizado.

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

## Ação DeleteUsageProfile (Python: delete\_usage\_profile)
<a name="aws-glue-api-usage-profiles-DeleteUsageProfile"></a>

Exclui o perfil de uso do AWS Glue especificado.

**Solicitação**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do perfil de uso a ser excluído.

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `OperationNotSupportedException`

## Ação ListUsageProfiles (Python: list\_usage\_profiles)
<a name="aws-glue-api-usage-profiles-ListUsageProfiles"></a>

Liste todos os perfis de uso do AWS Glue.

**Solicitação**
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, incluído se esta for uma chamada de continuação.
+ `MaxResults`: número (inteiro) não inferior a 1 nem superior a 200.

  O número máximo de perfis de uso a serem retornados em uma única resposta.

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

  Uma lista de objetos do perfil de uso (`UsageProfileDefinition`).
+ `NextToken`: string UTF-8, não superior a 400.000 bytes de comprimento.

  Um token de continuação, presente se o segmento de lista atual não for o último.

**Erros**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `OperationNotSupportedException`