received_data_grants

Creates, updates, deletes, gets or lists a received_data_grants resource.

Overview

Name	received_data_grants
Type	Resource
Id	aws.dataexchange.received_data_grants

Fields

The following fields are returned by SELECT queries:

get_received_data_grant

Name	Datatype	Description
acceptance_state	string	The acceptance state of the data grant. (PENDING_RECEIVER_ACCEPTANCE, ACCEPTED)
accepted_at	string (date-time)	The timestamp of when the data grant was accepted.
arn	string	The Amazon Resource Name (ARN) of the data grant.
created_at	string (date-time)	The timestamp of when the data grant was created.
data_set_id	string	The ID of the data set associated to the data grant. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
description	string	The description of the data grant.
ends_at	string (date-time)	The timestamp of when access to the associated data set ends.
grant_distribution_scope	string	The distribution scope for the data grant. (AWS_ORGANIZATION, NONE)
id	string	The ID of the data grant. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
name	string	The name of the data grant.
receiver_principal	string	The Amazon Web Services account ID of the data grant receiver. (pattern: <code>\d{12}</code>)
sender_principal	string	The Amazon Web Services account ID of the data grant sender. (pattern: <code>\d{12}</code>)
updated_at	string (date-time)	The timestamp of when the data grant was last updated.

list_received_data_grants

Name	Datatype	Description
acceptance_state	string	The acceptance state of the data grant. (PENDING_RECEIVER_ACCEPTANCE, ACCEPTED)
accepted_at	string (date-time)	The timestamp of when the data grant was accepted.
arn	string	The Amazon Resource Name (ARN) of the data grant.
created_at	string (date-time)	The timestamp of when the data grant was created.
data_set_id	string	The ID of the data set associated to the data grant. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
ends_at	string (date-time)	The timestamp of when access to the associated data set ends.
id	string	The ID of the data grant. (pattern: <code>[a-zA-Z0-9]{30,40}</code>)
name	string	The name of the data grant.
receiver_principal	string	The Amazon Web Services account ID of the data grant receiver. (pattern: <code>\d{12}</code>)
sender_principal	string	The Amazon Web Services account ID of the data grant sender. (pattern: <code>\d{12}</code>)
updated_at	string (date-time)	The timestamp of when the data grant was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_received_data_grant	select	data_grant_arn, region		This operation returns information about a received data grant.
list_received_data_grants	select	region	maxResults, nextToken, acceptanceState	This operation returns information about all received data grants.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
data_grant_arn	string	The Amazon Resource Name (ARN) of the data grant.
region	string	AWS region (default: us-east-1)
acceptanceState	array	The acceptance state of the data grants to list.
maxResults	integer	The maximum number of results to be included in the next page.
nextToken	string	The pagination token used to retrieve the next page of results for this operation.

SELECT examples

get_received_data_grant

This operation returns information about a received data grant.

SELECT
acceptance_state,
accepted_at,
arn,
created_at,
data_set_id,
description,
ends_at,
grant_distribution_scope,
id,
name,
receiver_principal,
sender_principal,
updated_at
FROM aws.dataexchange.received_data_grants
WHERE data_grant_arn = '{{ data_grant_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_received_data_grants

This operation returns information about all received data grants.

SELECT
acceptance_state,
accepted_at,
arn,
created_at,
data_set_id,
ends_at,
id,
name,
receiver_principal,
sender_principal,
updated_at
FROM aws.dataexchange.received_data_grants
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND acceptanceState = '{{ acceptanceState }}'
;