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á.
Essa ação retorna metadados sobre retenções legais ativas e anteriores.
Sintaxe da Solicitação
GET /legal-holds/?maxResults=MaxResults
&nextToken=NextToken
HTTP/1.1
Parâmetros da Solicitação de URI
A solicitação usa os seguintes parâmetros de URI:
- MaxResults
-
O número máximo de itens da lista de recursos a serem retornados.
Faixa válida: valor mínimo de 1. Valor máximo de 1.000.
- NextToken
-
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número
MaxResults
de recursos, oNextToken
permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.
Corpo da Solicitação
Essa solicitação não tem corpo.
Sintaxe da resposta
HTTP/1.1 200
Content-type: application/json
{
"LegalHolds": [
{
"CancellationDate": number,
"CreationDate": number,
"Description": "string",
"LegalHoldArn": "string",
"LegalHoldId": "string",
"Status": "string",
"Title": "string"
}
],
"NextToken": "string"
}
Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- LegalHolds
-
Isso é uma matriz de retenções legais retornadas, tanto ativas quanto anteriores.
Tipo: matriz de objetos LegalHold
- NextToken
-
O próximo item após uma lista parcial dos recursos retornados. Por exemplo, se uma solicitação for feita para retornar o número
MaxResults
de recursos, oNextToken
permitirá que você retorne mais itens em sua lista começando pelo local apontado pelo próximo token.Tipo: string
Erros
Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.
- InvalidParameterValueException
-
Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.
Código de status HTTP: 400
- ServiceUnavailableException
-
Houve falha na solicitação devido a um erro temporário do servidor.
Código de status HTTP: 500
Consulte também
Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte: