As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # Outras APIs do Neptune **Ações do:** + [AddTagsToResource (ação)](#AddTagsToResource) + [ListTagsForResource (ação)](#ListTagsForResource) + [RemoveTagsFromResource (ação)](#RemoveTagsFromResource) + [ApplyPendingMaintenanceAction (ação)](#ApplyPendingMaintenanceAction) + [DescribePendingMaintenanceActions (ação)](#DescribePendingMaintenanceActions) + [DescribeDBEngineVersions (ação)](#DescribeDBEngineVersions) **Estruturas:** + [DBEngineVersion (estrutura)](#DBEngineVersion) + [EngineDefaults (estrutura)](#EngineDefaults) + [PendingMaintenanceAction (estrutura)](#PendingMaintenanceAction) + [ResourcePendingMaintenanceActions (estrutura)](#ResourcePendingMaintenanceActions) + [UpgradeTarget (estrutura)](#UpgradeTarget) + [Tag (estrutura)](#Tag) ## AddTagsToResource (ação)         O nome da CLI da AWS para essa API é: `add-tags-to-resource`. Adiciona tags de metadados a um recurso do Amazon Neptune. Essas tags também podem ser usadas com os relatórios de alocação de custos para rastrear os custos associados a recursos do Amazon Neptune ou usadas em uma instrução de condição de uma política do IAM para o Amazon Neptune. **Solicitação** + **ResourceName** (na CLI: `--resource-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). O recurso do Amazon Neptune ao qual as tags são adicionadas. Esse valor é um nome do recurso da Amazon (ARN). Para obter informações sobre a criação de um ARN, consulte [Criação de um nome de recurso da Amazon (ARN) do Amazon ARN](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + **Tags** (na CLI: `--tags`): *obrigatório:* uma matriz de objetos [Tag](#Tag). As tags a serem atribuídas ao recurso do Amazon Neptune. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault) + [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault) + [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault) ## ListTagsForResource (ação)         O nome da CLI da AWS para essa API é: `list-tags-for-resource`. Lista todas as tags em um recurso do Amazon Neptune. **Solicitação** + **Filters** (na CLI: `--filters`): uma matriz de objetos [Filtro](api-datatypes.md#Filter). Não há suporte para esse parâmetro atualmente. + **ResourceName** (na CLI: `--resource-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). O recurso do Amazon Neptune com as tags a serem listadas. Esse valor é um nome do recurso da Amazon (ARN). Para obter informações sobre a criação de um ARN, consulte [Criação de um nome de recurso da Amazon (ARN) do Amazon ARN](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). **Resposta** + **TagList**: um array de objetos [Tag](#Tag). Lista de tags retornadas pela operação ListTagsForResource. **Erros** + [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault) + [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault) + [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault) ## RemoveTagsFromResource (ação)         O nome da CLI da AWS para essa API é: `remove-tags-from-resource`. Remove as tags de metadados de um recurso do Amazon Neptune. **Solicitação** + **ResourceName** (na CLI: `--resource-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). O recurso do Amazon Neptune do qual as tags são removidas. Esse valor é um nome do recurso da Amazon (ARN). Para obter informações sobre a criação de um ARN, consulte [Criação de um nome de recurso da Amazon (ARN) do Amazon ARN](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). + **TagKeys** (na CLI: `--tag-keys`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). A chave (nome) da tag a ser removida. **Resposta** + *Nenhum parâmetro de resposta.* **Erros** + [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault) + [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault) + [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault) ## ApplyPendingMaintenanceAction (ação)         O nome da CLI da AWS para essa API é: `apply-pending-maintenance-action`. Aplica uma ação de manutenção pendente a um recurso (por exemplo, a uma instância de banco de dados). **Solicitação** + **ApplyAction** (na CLI: `--apply-action`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). A ação de manutenção pendente a ser aplicada a esse recurso. Valores válidos: `system-update`, `db-upgrade` + **OptInType** (na CLI: `--opt-in-type`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). Um valor que especifica o tipo de solicitação de inclusão ou desfaz uma solicitação de inclusão. Uma solicitação de inclusão do tipo `immediate` não pode ser desfeita. Valores válidos: + `immediate` – aplique a ação de manutenção imediatamente. + `next-maintenance` – aplique a ação de manutenção durante a próxima janela de manutenção do recurso. + `undo-opt-in` – Cancela todas as solicitações de inclusão `next-maintenance` existentes. + **ResourceIdentifier** (na CLI: `--resource-identifier`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8). O nome de recurso da Amazon (ARN) do recurso ao qual a ação de manutenção pendente se aplica. Para obter informações sobre a criação de um ARN, consulte [Criação de um nome de recurso da Amazon (ARN) do Amazon ARN](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing). **Resposta** Descreve as ações de manutenção pendentes para um recurso. + **PendingMaintenanceActionDetails**: um array de objetos [PendingMaintenanceAction](#PendingMaintenanceAction). Uma lista que fornece detalhes sobre as ações de manutenção pendentes para o recurso. + **ResourceIdentifier**: uma string, do tipo: `string` (uma string codificada em UTF-8). O ARN do recurso que tem ações de manutenção pendentes. **Erros** + [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault) ## DescribePendingMaintenanceActions (ação)         O nome da CLI da AWS para essa API é: `describe-pending-maintenance-actions`. Retorna uma lista de recursos (por exemplo, instâncias de banco de dados) que têm pelo menos uma ação de manutenção pendente. **Solicitação** + **Filters** (na CLI: `--filters`): uma matriz de objetos [Filtro](api-datatypes.md#Filter). Um filtro que especifica um ou mais recursos para os quais retornar ações de manutenção pendentes. Filtros compatíveis: + `db-cluster-id` – aceita identificadores de cluster de banco de dados e os Nomes de recursos da Amazon (ARNs) do cluster de banco de dados. A lista de recursos só incluirá ações de manutenção pendentes para os clusters de bancos de dados identificados por esses ARNs. + `db-instance-id` – aceita identificadores de instância de banco de dados e ARNs de instâncias de banco de dados. A lista de recursos só incluirá ações de manutenção pendentes para as instâncias de bancos de dados identificadas por esses ARNs. + **Marker** (na CLI: `--marker`): uma string, do tipo: `string` (uma string codificada em UTF-8). Um token de paginação opcional fornecido por uma solicitação `DescribePendingMaintenanceActions` anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até um número de registros especificado por `MaxRecords`. + **MaxRecords** (na CLI: `--max-records`): um IntegerOptional, do tipo: `integer` (um valor inteiro assinado de 32 bits). O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor `MaxRecords` especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados. Padrão: 100 Restrições: mínimo de 20, máximo de 100. + **ResourceIdentifier** (na CLI: `--resource-identifier`): uma string, do tipo: `string` (uma string codificada em UTF-8). O ARN de um recurso para o qual retornar ações de manutenção pendentes. **Resposta** + **Marker**: uma string, do tipo: `string` (uma string codificada em UTF-8). Um token de paginação opcional fornecido por uma solicitação `DescribePendingMaintenanceActions` anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até um número de registros especificado por `MaxRecords`. + **PendingMaintenanceActions**: um array de objetos [ResourcePendingMaintenanceActions](#ResourcePendingMaintenanceActions). Uma lista das ações de manutenção pendentes para o recurso. **Erros** + [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault) ## DescribeDBEngineVersions (ação)         O nome da CLI da AWS para essa API é: `describe-db-engine-versions`. Retorna uma lista dos mecanismos de banco de dados disponíveis. **Solicitação** + **DBParameterGroupFamily** (na CLI: `--db-parameter-group-family`): uma string, do tipo: `string` (uma string codificada em UTF-8). O nome de uma família de grupos de parâmetros de banco de dados específica para a qual retornar detalhes. Restrições: + Se fornecido, deverá ser uma DBParameterGroupFamily existente. + **DefaultOnly** (na CLI: `--default-only`): um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Indica que somente a versão padrão do mecanismo especificado ou a combinação de mecanismo e versão principal é retornada. + **Engine** (na CLI: `--engine`): uma string, do tipo: `string` (uma string codificada em UTF-8). O mecanismo de banco de dados a ser retornado. + **EngineVersion** (na CLI: `--engine-version`): uma string, do tipo: `string` (uma string codificada em UTF-8). A versão do mecanismo de banco de dados a ser retornado. Exemplo: `5.1.49` + **Filters** (na CLI: `--filters`): uma matriz de objetos [Filtro](api-datatypes.md#Filter). Sem suporte no momento. + **ListSupportedCharacterSets** (na CLI: `--list-supported-character-sets`): um BooleanOptional, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Se esse parâmetro for especificado e o mecanismo solicitado for compatível com o parâmetro `CharacterSetName` para `CreateDBInstance`, a resposta incluirá uma lista de conjuntos de caracteres com suporte para cada versão do mecanismo. + **ListSupportedTimezones** (na CLI: `--list-supported-timezones`): um BooleanOptional, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Se esse parâmetro for especificado e o mecanismo solicitado for compatível com o parâmetro `TimeZone` para `CreateDBInstance`, a resposta incluirá uma lista de fusos horários com suporte para cada versão do mecanismo. + **Marker** (na CLI: `--marker`): uma string, do tipo: `string` (uma string codificada em UTF-8). Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`. + **MaxRecords** (na CLI: `--max-records`): um IntegerOptional, do tipo: `integer` (um valor inteiro assinado de 32 bits). O número máximo de registros a serem incluídos na resposta. Se mais do que o valor `MaxRecords` estiver disponível, um token de paginação chamado de marcador será incluído na resposta para que os resultados a seguir possam ser recuperados. Padrão: 100 Restrições: mínimo de 20, máximo de 100. **Resposta** + **DBEngineVersions**: um array de objetos [DBEngineVersion](#DBEngineVersion). Uma lista de elementos `DBEngineVersion`. + **Marker**: uma string, do tipo: `string` (uma string codificada em UTF-8). Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`. ## *Estruturas:* ## DBEngineVersion (estrutura) Esse tipo de dados é usado como um elemento de resposta na ação [DescribeDBEngineVersions (ação)](#DescribeDBEngineVersions). **Campos** + **DBEngineDescription**: é uma string, do tipo: `string` (uma string codificada em UTF-8). A descrição do mecanismo de banco de dados. + **DBEngineVersionDescription**: é uma string, do tipo: `string` (uma string codificada em UTF-8). A descrição da versão do mecanismo de banco de dados. + **DBParameterGroupFamily**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O nome da família de parameter groups de banco de dados para o mecanismo de banco de dados. + **Engine**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O nome do mecanismo de banco de dados. + **EngineVersion**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O número da versão do mecanismo de banco de dados. + **ExportableLogTypes**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Os tipos de logs que o mecanismo de banco de dados tem disponíveis para exportar para o CloudWatch Logs. + **SupportedTimezones**: é uma matriz de objetos [Fuso horário](api-datatypes.md#Timezone). Uma lista dos fusos horários compatíveis com esse mecanismo para o parâmetro `Timezone` da ação `CreateDBInstance`. + **SupportsGlobalDatabases**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Um valor que indica se você pode usar os bancos de dados globais do Aurora com uma versão específica do mecanismo de banco de dados. + **SupportsLogExportsToCloudwatchLogs**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Um valor que indica se a versão do mecanismo oferece suporte à exportação dos tipos de log especificados pelo ExportableLogTypes para o CloudWatch Logs. + **SupportsReadReplica**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Indica se a versão do mecanismo de banco de dados oferece suporte a réplicas de leitura. + **ValidUpgradeTarget**: é uma matriz de objetos [UpgradeTarget](#UpgradeTarget). Uma lista de versões do mecanismo para as quais essa versão do mecanismo de banco de dados pode ser atualizada. ## EngineDefaults (estrutura) Contém o resultado de uma invocação bem-sucedida da ação [DescribeEngineDefaultParameters (ação)](api-parameters.md#DescribeEngineDefaultParameters). **Campos** + **DBParameterGroupFamily**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Especifica o nome da família de grupos de parâmetros de banco de dados à qual os parâmetros padrão do mecanismo se aplicam. + **Marker**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Um token de paginação opcional fornecido por uma solicitação EngineDefaults anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords` . + **Parameters**: é uma matriz de objetos [Parameter](api-parameters.md#Parameter). Contém uma lista de parâmetros padrão do mecanismo. `EngineDefaults` é usado como o elemento de resposta para: + [DescribeEngineDefaultParameters](api-parameters.md#DescribeEngineDefaultParameters) + [DescribeEngineDefaultClusterParameters](api-parameters.md#DescribeEngineDefaultClusterParameters) ## PendingMaintenanceAction (estrutura) Fornece informações sobre uma ação de manutenção pendente para um recurso. **Campos** + **Action**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O tipo de ação de manutenção pendente que está disponível para o recurso. + **AutoAppliedAfterDate**: é um TStamp, do tipo: `timestamp` (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970). A data da janela de manutenção em que a ação é aplicada. A ação de manutenção é aplicada ao recurso durante a primeira janela de manutenção após essa data. Se essa data for especificada, todas as solicitações de inclusão `next-maintenance` serão ignoradas. + **CurrentApplyDate**: é um TStamp, do tipo: `timestamp` (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970). A data de início de vigência quando a ação de manutenção pendente é aplicada ao recurso. Essa data leva em conta as solicitações recebidas de inclusão da API [ApplyPendingMaintenanceAction (ação)](#ApplyPendingMaintenanceAction), `AutoAppliedAfterDate` e `ForcedApplyDate`. Esse valor estará em branco se uma solicitação de inclusão não foi recebida e nada tiver sido especificado como `AutoAppliedAfterDate` ou `ForcedApplyDate`. + **Description**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Uma descrição que fornece mais detalhes sobre a ação de manutenção. + **ForcedApplyDate**: é um TStamp, do tipo: `timestamp` (um ponto no tempo, geralmente definido como um desvio da meia-noite de 01/01/1970). A data em que a ação de manutenção é aplicada automaticamente. A ação de manutenção é aplicada ao recurso nessa data, independentemente da janela de manutenção para o recurso. Se essa data for especificada, todas as solicitações de inclusão `immediate` serão ignoradas. + **OptInStatus**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Indica o tipo de solicitação de inclusão que foi recebida para o recurso. ## ResourcePendingMaintenanceActions (estrutura) Descreve as ações de manutenção pendentes para um recurso. **Campos** + **PendingMaintenanceActionDetails**: é uma matriz de objetos [PendingMaintenanceAction](#PendingMaintenanceAction). Uma lista que fornece detalhes sobre as ações de manutenção pendentes para o recurso. + **ResourceIdentifier**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O ARN do recurso que tem ações de manutenção pendentes. `ResourcePendingMaintenanceActions` é usado como o elemento de resposta para: + [ApplyPendingMaintenanceAction](#ApplyPendingMaintenanceAction) ## UpgradeTarget (estrutura) A versão do mecanismo de banco de dados para a qual uma instância de banco de dados pode ser atualizada. **Campos** + **AutoUpgrade**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Um valor que indica se a versão de destino é aplicada a todas as instâncias de banco de dados de origem que têm AutoMinorVersionUpgrade definido como true. + **Description**: é uma string, do tipo: `string` (uma string codificada em UTF-8). A versão do mecanismo de banco de dados para a qual uma instância de banco de dados pode ser atualizada. + **Engine**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O nome do mecanismo de banco de dados de destino de atualização. + **EngineVersion**: é uma string, do tipo: `string` (uma string codificada em UTF-8). O número da versão do mecanismo de banco de dados de destino de atualização. + **IsMajorVersionUpgrade**: é um valor booliano, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Um valor que indica se um mecanismo de banco de dados é atualizado para uma versão principal. + **SupportsGlobalDatabases**: é um BooleanOptional, do tipo: `boolean` (um valor booliano (verdadeiro ou falso)). Um valor que indica se você pode usar os bancos de dados globais do Neptune com a versão do mecanismo de destino. ## Tag (estrutura) Metadados atribuídos a um recurso do Amazon Neptune consistente de um par chave/valor. **Campos** + **Key**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Uma chave é o nome obrigatório da tag. O valor da string pode ter de 1 a 128 caracteres Unicode e não pode ter os prefixos `aws:` ou `rds:`. A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”). + **Value**: é uma string, do tipo: `string` (uma string codificada em UTF-8). Um valor é o valor opcional da tag. O valor da string pode ter de 1 a 256 caracteres Unicode e não pode ter os prefixos `aws:` ou `rds:`. A string pode conter apenas o conjunto de letras em Unicode, dígitos, espaço em branco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”).