# APIs de segurança no AWS Glue A API de segurança descreve os tipos de dados de segurança e a API relacionada à segurança no AWS Glue. ## Tipos de dados + [Estrutura DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings) + [Estrutura EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest) + [Estrutura ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption) + [Estrutura EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration) + [Estrutura S3Encryption](#aws-glue-api-jobs-security-S3Encryption) + [Estrutura CloudWatchEncryption](#aws-glue-api-jobs-security-CloudWatchEncryption) + [Estrutura JobBookmarksEncryption](#aws-glue-api-jobs-security-JobBookmarksEncryption) + [Estrutura SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration) + [Estrutura GluePolicy](#aws-glue-api-jobs-security-GluePolicy) + [Estrutura DataQualityEncryption](#aws-glue-api-jobs-security-DataQualityEncryption) ## Estrutura DataCatalogEncryptionSettings Contém informações de configuração para manter a segurança do Catálogo de dados. **Campos** + `EncryptionAtRest` – Um objeto [EncryptionAtRest](#aws-glue-api-jobs-security-EncryptionAtRest). Especifica a configuração de criptografia em repouso para o Catálogo de dados. + `ConnectionPasswordEncryption` – Um objeto [ConnectionPasswordEncryption](#aws-glue-api-jobs-security-ConnectionPasswordEncryption). Quando a proteção por senha de conexão é habilitada, o Catálogo de dados usa uma chave fornecida pelo cliente para criptografar a senha como parte do `CreateConnection` ou `UpdateConnection` armazená-la no `ENCRYPTED_PASSWORD` campo nas propriedades da conexão. Você pode habilitar a criptografia de catálogo ou apenas a criptografia de senha. ## Estrutura EncryptionAtRest Especifica a configuração de criptografia em repouso para o Catálogo de dados. **Campos** + `CatalogEncryptionMode` – *Obrigatório:* string UTF-8 (valores válidos: `DISABLED` \| `SSE-KMS="SSEKMS"` \| `SSE-KMS-WITH-SERVICE-ROLE="SSEKMSWITHSERVICEROLE"`). O modo de criptografia em repouso para a configuração de dados do Catálogo de dados. + `SseAwsKmsKeyId` – 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 ID da chave do AWS KMS a ser usada para a criptografia em repouso. + `CatalogEncryptionServiceRole` – String UTF-8 correspondente a [Custom string pattern #53](aws-glue-api-common.md#regex_53). O perfil assumido pelo AWS Glue para criptografar e descriptografar os objetos do Catálogo de Dados em nome do chamador. ## Estrutura ConnectionPasswordEncryption A estrutura de dados usada pelo Catálogo de dados para criptografar a senha como parte do `CreateConnection` ou `UpdateConnection` e armazená-la no `ENCRYPTED_PASSWORD` campo nas propriedades da conexão. Você pode habilitar a criptografia de catálogo ou apenas a criptografia de senha. Quando uma solicitação `CreationConnection` chega contendo uma senha, o Data Catalog primeiro criptografa a senha usando a sua chave do AWS KMS. Em seguida, criptografa todo o objeto de conexão novamente se a criptografia do catálogo também estiver habilitada. Essa criptografia requer que as permissões de chave do AWS KMS sejam definidas para habilitar ou restringir o acesso à chave da senha de acordo com os seus requisitos de segurança. Por exemplo, você pode querer que apenas administradores tenham permissão para descriptografar a chave da senha. **Campos** + `ReturnConnectionPasswordEncrypted`: *obrigatório:* booleano. Quando o `ReturnConnectionPasswordEncrypted` sinalizador estiver definido como "verdadeiro", as senhas permanecem criptografadas nas respostas de `GetConnection` e `GetConnections`. Esta criptografia entra em vigor independentemente da criptografia de catálogo. + `AwsKmsKeyId` – 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). Uma chave do AWS KMS usada para criptografar a senha de conexão. Se a proteção por senha da conexão estiver habilitada, o autor da chamada de `CreateConnection` e `UpdateConnection` precisará, pelo menos, da permissão `kms:Encrypt` na chave do AWS KMS especificada para criptografar as senhas antes de armazená-las no Data Catalog. Você pode definir a permissão de descriptografia para habilitar ou restringir o acesso à chave de senha, de acordo com os seus requisitos de segurança. ## Estrutura EncryptionConfiguration Especifica uma configuração de criptografia. **Campos** + `S3Encryption`: um array de objetos [S3Encryption](#aws-glue-api-jobs-security-S3Encryption). A configuração da criptografia para os dados do Amazon Simple Storage Service (Amazon S3). + `CloudWatchEncryption` – Um objeto [CloudWatchEncryption](#aws-glue-api-jobs-security-CloudWatchEncryption). A configuração da criptografia para o Amazon CloudWatch. + `JobBookmarksEncryption` – Um objeto [JobBookmarksEncryption](#aws-glue-api-jobs-security-JobBookmarksEncryption). A configuração da criptografia para marcadores de trabalho. + `DataQualityEncryption` – Um objeto [DataQualityEncryption](#aws-glue-api-jobs-security-DataQualityEncryption). A configuração de criptografia para os ativos do AWS Glue Data Quality. ## Estrutura S3Encryption Especifica como os dados do Amazon Simple Storage Service (Amazon S3) devem ser criptografados. **Campos** + `S3EncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \| `SSE-KMS="SSEKMS"` \| `SSE-S3="SSES3"`). O modo de criptografia a ser usado para dados do Amazon S3. + `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42). O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados. ## Estrutura CloudWatchEncryption Especifica como os dados do Amazon CloudWatch devem ser criptografados. **Campos** + `CloudWatchEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \| `SSE-KMS="SSEKMS"`). O modo de criptografia a ser usado para dados do CloudWatch. + `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42). O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados. ## Estrutura JobBookmarksEncryption Especifica como os dados de marcadores de trabalho devem ser criptografados. **Campos** + `JobBookmarksEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \| `CSE-KMS="CSEKMS"`). O modo de criptografia a ser usado para dados de marcadores de trabalho. + `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42). O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados. ## Estrutura SecurityConfiguration Especifica uma configuração de segurança. **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 da configuração de segurança. + `CreatedTimeStamp` – Timestamp. O momento em que esta configuração de segurança foi criada. + `EncryptionConfiguration` – Um objeto [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration). A configuração de criptografia associada a essa configuração de segurança. ## Estrutura GluePolicy Uma estrutura para retornar uma política de recursos. **Campos** + `PolicyInJson` – String UTF-8, com pelo menos 2 bytes de comprimento. Contém o documento da política solicitada no formato JSON. + `PolicyHash` – 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). Contém o valor de hash associado a essa política. + `CreateTime` – Timestamp. A data e hora em que a política foi criada. + `UpdateTime` – Timestamp. A data e hora em que a política foi atualizada pela última vez. ## Estrutura DataQualityEncryption Especifica como os ativos do Data Quality em sua conta devem ser criptografados. **Campos** + `DataQualityEncryptionMode` – string UTF-8 (valores válidos: `DISABLED` \| `SSE-KMS="SSEKMS"`). O modo de criptografia a ser usado para a criptografia dos ativos do Data Quality. Esses ativos incluem conjuntos de regras de qualidade de dados, resultados, estatísticas, modelos de detecção de anomalias e observações. Os valores válidos são `SSEKMS`, para a criptografia com uma chave do KMS gerenciada pelo cliente, ou `DISABLED`. + `KmsKeyArn` – String UTF-8 correspondente a [Custom string pattern #42](aws-glue-api-common.md#regex_42). O nome de recurso da Amazon (ARN) da chave do KMS a ser usada para criptografar os dados. ## Operações + [Ação GetDataCatalogEncryptionSettings (Python: get\_data\_catalog\_encryption\_settings)](#aws-glue-api-jobs-security-GetDataCatalogEncryptionSettings) + [Ação PutDataCatalogEncryptionSettings (Python: put\_data\_catalog\_encryption\_settings)](#aws-glue-api-jobs-security-PutDataCatalogEncryptionSettings) + [Ação PutResourcePolicy (Python: put\_resource\_policy)](#aws-glue-api-jobs-security-PutResourcePolicy) + [Ação GetResourcePolicy (Python: get\_resource\_policy)](#aws-glue-api-jobs-security-GetResourcePolicy) + [Ação DeleteResourcePolicy (Python: delete\_resource\_policy)](#aws-glue-api-jobs-security-DeleteResourcePolicy) + [Ação CreateSecurityConfiguration (Python: create\_security\_configuration)](#aws-glue-api-jobs-security-CreateSecurityConfiguration) + [Ação DeleteSecurityConfiguration (Python: delete\_security\_configuration)](#aws-glue-api-jobs-security-DeleteSecurityConfiguration) + [Ação GetSecurityConfiguration (Python: get\_security\_configuration)](#aws-glue-api-jobs-security-GetSecurityConfiguration) + [Ação GetSecurityConfigurations (Python: get\_security\_configurations)](#aws-glue-api-jobs-security-GetSecurityConfigurations) + [Ação GetResourcePolicies (Python: get\_resource\_policies)](#aws-glue-api-jobs-security-GetResourcePolicies) ## Ação GetDataCatalogEncryptionSettings (Python: get\_data\_catalog\_encryption\_settings) Recupera a configuração de segurança de um determinado catálogo. **Solicitação** + `CatalogId` – string de ID de catálogo 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 ID do Catálogo de dados para o qual recuperar a configuração de segurança. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão. **Resposta** + `DataCatalogEncryptionSettings` – Um objeto [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings). A configuração de segurança solicitada. **Erros** + `InternalServiceException` + `InvalidInputException` + `OperationTimeoutException` ## Ação PutDataCatalogEncryptionSettings (Python: put\_data\_catalog\_encryption\_settings) Define a configuração de segurança de um determinado catálogo. Depois que a configuração tiver sido definida, a criptografia especificada será aplicada a cada gravação de catálogo a partir de então. **Solicitação** + `CatalogId` – string de ID de catálogo 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 ID do Catálogo de dados para o qual definir a configuração de segurança. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão. + `DataCatalogEncryptionSettings` – *Obrigatório:* um objeto [DataCatalogEncryptionSettings](#aws-glue-api-jobs-security-DataCatalogEncryptionSettings). A configuração de segurança a ser definida. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `InternalServiceException` + `InvalidInputException` + `OperationTimeoutException` ## Ação PutResourcePolicy (Python: put\_resource\_policy) Define a política de recurso de catálogo de dados para controle de acesso. **Solicitação** + `PolicyInJson` – *Obrigatório:* String UTF-8, com pelo menos 2 bytes de comprimento. Contém o documento de política a ser definido, no formato JSON. + `ResourceArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50). Não use. Apenas para uso interno. + `PolicyHashCondition` – 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 valor de hash retornado quando a política anterior foi definida usando `PutResourcePolicy`. O objetivo é impedir modificações simultâneas de uma política. Não use esse parâmetro se nenhuma política anterior tiver sido definida. + `PolicyExistsCondition` – string UTF-8 (valores válidos: `MUST_EXIST` \| `NOT_EXIST` \| `NONE`). Um valor de `MUST_EXIST` é usado para atualizar uma política. Um valor de `NOT_EXIST` é usado para criar uma nova política. Se um valor de `NONE` ou um valor nulo for usado, a chamada não dependerá da existência de uma política. + `EnableHybrid` – string UTF-8 (valores válidos: `TRUE` \| `FALSE`). Se for `'TRUE'`, indica que você está usando os dois métodos para conceder acesso entre contas aos recursos do Data Catalog: + Atualizando diretamente a política de recursos com `PutResourePolicy` + Usando a opção **Grant permissions** (Conceder permissões) no Console de gerenciamento da AWS. Deve ser definida como `'TRUE'` se você já tiver usado o Console de Gerenciamento para conceder acesso entre contas, caso contrário, a chamada falhará. O padrão é “FALSE” (FALSO). **Resposta** + `PolicyHash` – 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). Um hash da política que acabou de ser definida. Isso deve ser incluído em uma chamada subsequente que substitui ou atualiza essa política. **Erros** + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` + `ConditionCheckFailureException` ## Ação GetResourcePolicy (Python: get\_resource\_policy) Recupera uma política de recurso especificada. **Solicitação** + `ResourceArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50). O ARN do recurso do AWS Glue para o qual se deseja recuperar a política de recurso. Se não for fornecido, a política de recurso do Data Catalog será retornada. Use `GetResourcePolicies` para exibir todas as políticas de recursos existentes. Para obter mais informações, consulte [Especificar ARNs de recurso do AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/glue-specifying-resource-arns.html). **Resposta** + `PolicyInJson` – String UTF-8, com pelo menos 2 bytes de comprimento. Contém o documento da política solicitada no formato JSON. + `PolicyHash` – 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). Contém o valor de hash associado a essa política. + `CreateTime` – Timestamp. A data e hora em que a política foi criada. + `UpdateTime` – Timestamp. A data e hora em que a política foi atualizada pela última vez. **Erros** + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` ## Ação DeleteResourcePolicy (Python: delete\_resource\_policy) Exclui uma política especificada. **Solicitação** + `PolicyHashCondition` – 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 valor de hash retornado quando essa política foi definida. + `ResourceArn` – string UTF-8, não menos do que 1 ou superior a 10.240 bytes de comprimento, correspondente a [Custom string pattern #50](aws-glue-api-common.md#regex_50). O ARN do recurso do AWS Glue para a política de recursos a ser excluída. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `EntityNotFoundException` + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` + `ConditionCheckFailureException` ## Ação CreateSecurityConfiguration (Python: create\_security\_configuration) Cria uma nova configuração de segurança; Uma configuração de segurança é um conjunto de propriedades de segurança que pode ser usado pelo AWS Glue. Você pode usar uma configuração de segurança para criptografar dados em repouso. Para obter informações sobre como usar as configurações de segurança no AWS Glue, consulte [Criptografar dados gravados por crawlers, trabalhos e endpoints de desenvolvimento](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html). **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 da nova configuração de segurança. + `EncryptionConfiguration` – *Obrigatório:* um objeto [EncryptionConfiguration](#aws-glue-api-jobs-security-EncryptionConfiguration). A configuração de criptografia da nova configuração de segurança. **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 atribuído à nova configuração de segurança. + `CreatedTimestamp` – Timestamp. O momento em que a nova configuração de segurança foi criada. **Erros** + `AlreadyExistsException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` + `ResourceNumberLimitExceededException` ## Ação DeleteSecurityConfiguration (Python: delete\_security\_configuration) Exclui uma configuração de segurança especificada. **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 da configuração de segurança a ser excluída. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Ação GetSecurityConfiguration (Python: get\_security\_configuration) Recupera uma configuração de segurança especificada. **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 da configuração de segurança a ser recuperada. **Resposta** + `SecurityConfiguration` – Um objeto [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration). A configuração de segurança solicitada. **Erros** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Ação GetSecurityConfigurations (Python: get\_security\_configurations) Recupera uma lista de todas as configurações de segurança. **Solicitação** + `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000. O número máximo de resultados a serem retornados. + `NextToken` – String UTF-8. Um token de continuação, se esta for uma chamada de continuação. **Resposta** + `SecurityConfigurations`: um array de objetos [SecurityConfiguration](#aws-glue-api-jobs-security-SecurityConfiguration). Uma lista de configurações de segurança. + `NextToken` – String UTF-8. Um token de continuação, se houver mais configurações de segurança para retornar. **Erros** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `OperationTimeoutException` ## Ação GetResourcePolicies (Python: get\_resource\_policies) Recupera as políticas de recursos definidas em recursos individuais pelo AWS Resource Access Manager durante concessões de permissões entre contas. Recupera também a política de recurso do Data Catalog. Se você tiver ativado a criptografia de metadados nas definições do Data Catalog e não tiver permissão na chave do AWS KMS, a operação não poderá retornar a política de recurso do Data Catalog. **Solicitação** + `NextToken` – String UTF-8. Um token de continuação, se esta for uma solicitação de continuação. + `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000. O tamanho máximo de uma lista a ser retornada. **Resposta** + `GetResourcePoliciesResponseList`: um array de objetos [GluePolicy](#aws-glue-api-jobs-security-GluePolicy). Uma lista das políticas de recursos individuais e a política de recursos de nível de conta. + `NextToken` – String UTF-8. Um token de continuação, se a lista retornada não contiver a política de recurso mais recente disponível. **Erros** + `InternalServiceException` + `OperationTimeoutException` + `InvalidInputException` + `GlueEncryptionException`