Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListDataGrants

This operation returns information about all data grants.

Request Syntax


GET /v1/data-grants?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to be included in the next page.

Valid Range: Minimum value of 1. Maximum value of 200.

NextToken

The pagination token used to retrieve the next page of results for this operation.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DataGrantSummaries": [ 
      { 
         "AcceptanceState": "string",
         "AcceptedAt": "string",
         "Arn": "string",
         "CreatedAt": "string",
         "DataSetId": "string",
         "EndsAt": "string",
         "Id": "string",
         "Name": "string",
         "ReceiverPrincipal": "string",
         "SenderPrincipal": "string",
         "SourceDataSetId": "string",
         "UpdatedAt": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DataGrantSummaries

An object that contains a list of data grant information.

Type: Array of DataGrantSummaryEntry objects

NextToken

The pagination token used to retrieve the next page of results for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to the resource is denied.

Message: Access to the resource is denied.

HTTP Status Code: 403

InternalServerException

An exception occurred with the service.

Message: The message identifying the service exception that occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource couldn't be found.

Message: The resource couldn't be found.
ResourceId: The unique identifier for the resource that couldn't be found.
ResourceType: The type of resource that couldn't be found.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

Message: The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request was invalid.

ExceptionCause: The unique identifier for the resource that couldn't be found.
Message: The message that informs you about what was invalid about the request.

HTTP Status Code: 400