UpdateAsset
This operation updates an asset.
Request Syntax
PATCH /v1/data-sets/DataSetId/revisions/RevisionId/assets/AssetId HTTP/1.1
Content-type: application/json
{
"Name": "string"
}URI Request Parameters
The request uses the following URI parameters.
- AssetId
-
The unique identifier for an asset.
Required: Yes
- DataSetId
-
The unique identifier for a data set.
Required: Yes
- RevisionId
-
The unique identifier for a revision.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Name
-
The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy" or "Table(s) included in LF-tag policy" are used as the name.
Type: String
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"AssetDetails": {
"ApiGatewayApiAsset": {
"ApiDescription": "string",
"ApiEndpoint": "string",
"ApiId": "string",
"ApiKey": "string",
"ApiName": "string",
"ApiSpecificationDownloadUrl": "string",
"ApiSpecificationDownloadUrlExpiresAt": "string",
"ProtocolType": "string",
"Stage": "string"
},
"LakeFormationDataPermissionAsset": {
"LakeFormationDataPermissionDetails": {
"LFTagPolicy": {
"CatalogId": "string",
"ResourceDetails": {
"Database": {
"Expression": [
{
"TagKey": "string",
"TagValues": [ "string" ]
}
]
},
"Table": {
"Expression": [
{
"TagKey": "string",
"TagValues": [ "string" ]
}
]
}
},
"ResourceType": "string"
}
},
"LakeFormationDataPermissionType": "string",
"Permissions": [ "string" ],
"RoleArn": "string"
},
"RedshiftDataShareAsset": {
"Arn": "string"
},
"S3DataAccessAsset": {
"Bucket": "string",
"KeyPrefixes": [ "string" ],
"Keys": [ "string" ],
"KmsKeysToGrant": [
{
"KmsKeyArn": "string"
}
],
"S3AccessPointAlias": "string",
"S3AccessPointArn": "string"
},
"S3SnapshotAsset": {
"Size": number
}
},
"AssetType": "string",
"CreatedAt": "string",
"DataSetId": "string",
"Id": "string",
"Name": "string",
"RevisionId": "string",
"SourceId": "string",
"UpdatedAt": "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.
- Arn
-
The ARN for the asset.
Type: String
- AssetDetails
-
Details about the asset.
Type: AssetDetails object
- AssetType
-
The type of asset that is added to a data set.
Type: String
Valid Values:
S3_SNAPSHOT | REDSHIFT_DATA_SHARE | API_GATEWAY_API | S3_DATA_ACCESS | LAKE_FORMATION_DATA_PERMISSION - CreatedAt
-
The date and time that the asset was created, in ISO 8601 format.
Type: Timestamp
- DataSetId
-
The unique identifier for the data set associated with this asset.
Type: String
- Id
-
The unique identifier for the asset.
Type: String
- Name
-
The name of the asset. When importing from Amazon S3, the Amazon S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target Amazon S3 object key. When importing from Amazon API Gateway API, the API name is used as the asset name. When importing from Amazon Redshift, the datashare name is used as the asset name. When importing from AWS Lake Formation, the static values of "Database(s) included in the LF-tag policy"- or "Table(s) included in LF-tag policy" are used as the asset name.
Type: String
- RevisionId
-
The unique identifier for the revision associated with this asset.
Type: String
- SourceId
-
The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when an asset owner is viewing the entitled copy of its owned asset.
Type: String
- UpdatedAt
-
The date and time that the asset was last updated, in ISO 8601 format.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to the resource is denied.
HTTP Status Code: 403
- ConflictException
-
The request couldn't be completed because it conflicted with the current state of the resource.
HTTP Status Code: 409
- InternalServerException
-
An exception occurred with the service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource couldn't be found.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second was exceeded.
HTTP Status Code: 429
- ValidationException
-
The request was invalid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
