CreateDataGrant
This operation creates a data grant.
Request Syntax
POST /v1/data-grants HTTP/1.1
Content-type: application/json
{
"Description": "string",
"EndsAt": "string",
"GrantDistributionScope": "string",
"Name": "string",
"ReceiverPrincipal": "string",
"SourceDataSetId": "string",
"Tags": {
"string" : "string"
}
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Description
-
The description of the data grant.
Type: String
Required: No
- EndsAt
-
The timestamp of when access to the associated data set ends.
Type: Timestamp
Required: No
- GrantDistributionScope
-
The distribution scope of the data grant.
Type: String
Valid Values:
AWS_ORGANIZATION | NONERequired: Yes
- Name
-
The name of the data grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- ReceiverPrincipal
-
The AWS account ID of the data grant receiver.
Type: String
Pattern:
\d{12}Required: Yes
- SourceDataSetId
-
The ID of the data set used to create the data grant.
Type: String
Required: Yes
- Tags
-
The tags to add to the data grant. A tag is a key-value pair.
Type: String to string map
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"AcceptanceState": "string",
"AcceptedAt": "string",
"Arn": "string",
"CreatedAt": "string",
"DataSetId": "string",
"Description": "string",
"EndsAt": "string",
"GrantDistributionScope": "string",
"Id": "string",
"Name": "string",
"ReceiverPrincipal": "string",
"SenderPrincipal": "string",
"SourceDataSetId": "string",
"Tags": {
"string" : "string"
},
"UpdatedAt": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- AcceptanceState
-
The acceptance state of the data grant.
Type: String
Valid Values:
PENDING_RECEIVER_ACCEPTANCE | ACCEPTED - AcceptedAt
-
The timestamp of when the data grant was accepted.
Type: Timestamp
- Arn
-
The Amazon Resource Name (ARN) of the data grant.
Type: String
- CreatedAt
-
The timestamp of when the data grant was created.
Type: Timestamp
- DataSetId
-
The ID of the data set associated to the data grant.
Type: String
- Description
-
The description of the data grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16384.
- EndsAt
-
The timestamp of when access to the associated data set ends.
Type: Timestamp
- GrantDistributionScope
-
The distribution scope for the data grant.
Type: String
Valid Values:
AWS_ORGANIZATION | NONE - Id
-
The ID of the data grant.
Type: String
- Name
-
The name of the data grant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- ReceiverPrincipal
-
The AWS account ID of the data grant receiver.
Type: String
Pattern:
\d{12} - SenderPrincipal
-
The AWS account ID of the data grant sender.
Type: String
Pattern:
\d{12} - SourceDataSetId
-
The ID of the data set used to create the data grant.
Type: String
- Tags
-
The tags associated to the data grant. A tag is a key-value pair.
Type: String to string map
- UpdatedAt
-
The timestamp of when the data grant was last updated.
Type: Timestamp
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
- ServiceLimitExceededException
-
The request has exceeded the quotas imposed by the service.
- LimitName
-
The name of the limit that was reached.
- LimitValue
-
The value of the exceeded limit.
- Message
-
The request has exceeded the quotas imposed by the service.
HTTP Status Code: 402
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
