AcceptDataGrant

$result = $client->acceptDataGrant([/* ... */]);
$promise = $client->acceptDataGrantAsync([/* ... */]);

This operation accepts a data grant.

Parameter Syntax

$result = $client->acceptDataGrant([
    'DataGrantArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
    'AcceptedAt' => <DateTime>,
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Description' => '<string>',
    'EndsAt' => <DateTime>,
    'GrantDistributionScope' => 'AWS_ORGANIZATION|NONE',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReceiverPrincipal' => '<string>',
    'SenderPrincipal' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

This operation cancels a job. Jobs can be cancelled only when they are in the WAITING state.

Parameter Syntax

$result = $client->cancelJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CreateDataGrant

$result = $client->createDataGrant([/* ... */]);
$promise = $client->createDataGrantAsync([/* ... */]);

This operation creates a data grant.

Parameter Syntax

$result = $client->createDataGrant([
    'Description' => '<string>',
    'EndsAt' => <integer || string || DateTime>,
    'GrantDistributionScope' => 'AWS_ORGANIZATION|NONE', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ReceiverPrincipal' => '<string>', // REQUIRED
    'SourceDataSetId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
    'AcceptedAt' => <DateTime>,
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Description' => '<string>',
    'EndsAt' => <DateTime>,
    'GrantDistributionScope' => 'AWS_ORGANIZATION|NONE',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReceiverPrincipal' => '<string>',
    'SenderPrincipal' => '<string>',
    'SourceDataSetId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ServiceLimitExceededException:

The request has exceeded the quotas imposed by the service.

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CreateDataSet

$result = $client->createDataSet([/* ... */]);
$promise = $client->createDataSetAsync([/* ... */]);

This operation creates a data set.

Parameter Syntax

$result = $client->createDataSet([
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'DataGrantId' => '<string>',
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ServiceLimitExceededException:

The request has exceeded the quotas imposed by the service.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CreateEventAction

$result = $client->createEventAction([/* ... */]);
$promise = $client->createEventActionAsync([/* ... */]);

This operation creates an event action.

Parameter Syntax

$result = $client->createEventAction([
    'Action' => [ // REQUIRED
        'ExportRevisionToS3' => [
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256', // REQUIRED
            ],
            'RevisionDestination' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'KeyPattern' => '<string>',
            ],
        ],
    ],
    'Event' => [ // REQUIRED
        'RevisionPublished' => [
            'DataSetId' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'Action' => [
        'ExportRevisionToS3' => [
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionDestination' => [
                'Bucket' => '<string>',
                'KeyPattern' => '<string>',
            ],
        ],
    ],
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Event' => [
        'RevisionPublished' => [
            'DataSetId' => '<string>',
        ],
    ],
    'Id' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ServiceLimitExceededException:

The request has exceeded the quotas imposed by the service.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CreateJob

$result = $client->createJob([/* ... */]);
$promise = $client->createJobAsync([/* ... */]);

This operation creates a job.

Parameter Syntax

$result = $client->createJob([
    'Details' => [ // REQUIRED
        'CreateS3DataAccessFromS3Bucket' => [
            'AssetSource' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'KeyPrefixes' => ['<string>', ...],
                'Keys' => ['<string>', ...],
                'KmsKeysToGrant' => [
                    [
                        'KmsKeyArn' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [ // REQUIRED
                [
                    'AssetId' => '<string>', // REQUIRED
                    'Bucket' => '<string>', // REQUIRED
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>', // REQUIRED
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256', // REQUIRED
            ],
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ExportRevisionsToS3' => [
            'DataSetId' => '<string>', // REQUIRED
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256', // REQUIRED
            ],
            'RevisionDestinations' => [ // REQUIRED
                [
                    'Bucket' => '<string>', // REQUIRED
                    'KeyPattern' => '<string>',
                    'RevisionId' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'ImportAssetFromApiGatewayApi' => [
            'ApiDescription' => '<string>',
            'ApiId' => '<string>', // REQUIRED
            'ApiKey' => '<string>',
            'ApiName' => '<string>', // REQUIRED
            'ApiSpecificationMd5Hash' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'ProtocolType' => 'REST', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
            'Stage' => '<string>', // REQUIRED
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'Md5Hash' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ImportAssetsFromLakeFormationTagPolicy' => [
            'CatalogId' => '<string>', // REQUIRED
            'DataSetId' => '<string>', // REQUIRED
            'Database' => [
                'Expression' => [ // REQUIRED
                    [
                        'TagKey' => '<string>', // REQUIRED
                        'TagValues' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...], // REQUIRED
            ],
            'RevisionId' => '<string>', // REQUIRED
            'RoleArn' => '<string>', // REQUIRED
            'Table' => [
                'Expression' => [ // REQUIRED
                    [
                        'TagKey' => '<string>', // REQUIRED
                        'TagValues' => ['<string>', ...], // REQUIRED
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...], // REQUIRED
            ],
        ],
        'ImportAssetsFromRedshiftDataShares' => [
            'AssetSources' => [ // REQUIRED
                [
                    'DataShareArn' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [ // REQUIRED
                [
                    'Bucket' => '<string>', // REQUIRED
                    'Key' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'DataSetId' => '<string>', // REQUIRED
            'RevisionId' => '<string>', // REQUIRED
        ],
    ],
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL|EXPORT_REVISIONS_TO_S3|IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES|IMPORT_ASSET_FROM_API_GATEWAY_API|CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET|IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Details' => [
        'CreateS3DataAccessFromS3Bucket' => [
            'AssetSource' => [
                'Bucket' => '<string>',
                'KeyPrefixes' => ['<string>', ...],
                'Keys' => ['<string>', ...],
                'KmsKeysToGrant' => [
                    [
                        'KmsKeyArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>',
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [
                [
                    'AssetId' => '<string>',
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionId' => '<string>',
        ],
        'ExportRevisionsToS3' => [
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'EventActionArn' => '<string>',
            'RevisionDestinations' => [
                [
                    'Bucket' => '<string>',
                    'KeyPattern' => '<string>',
                    'RevisionId' => '<string>',
                ],
                // ...
            ],
        ],
        'ImportAssetFromApiGatewayApi' => [
            'ApiDescription' => '<string>',
            'ApiId' => '<string>',
            'ApiKey' => '<string>',
            'ApiName' => '<string>',
            'ApiSpecificationMd5Hash' => '<string>',
            'ApiSpecificationUploadUrl' => '<string>',
            'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
            'DataSetId' => '<string>',
            'ProtocolType' => 'REST',
            'RevisionId' => '<string>',
            'Stage' => '<string>',
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>',
            'DataSetId' => '<string>',
            'Md5Hash' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ImportAssetsFromLakeFormationTagPolicy' => [
            'CatalogId' => '<string>',
            'DataSetId' => '<string>',
            'Database' => [
                'Expression' => [
                    [
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...],
            ],
            'RevisionId' => '<string>',
            'RoleArn' => '<string>',
            'Table' => [
                'Expression' => [
                    [
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...],
            ],
        ],
        'ImportAssetsFromRedshiftDataShares' => [
            'AssetSources' => [
                [
                    'DataShareArn' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [
                [
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
    ],
    'Errors' => [
        [
            'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
            'Details' => [
                'ImportAssetFromSignedUrlJobErrorDetails' => [
                    'AssetName' => '<string>',
                ],
                'ImportAssetsFromS3JobErrorDetails' => [
                    [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LimitName' => 'Assets per revision|Asset size in GB|Amazon Redshift datashare assets per revision|AWS Lake Formation data permission assets per revision|Amazon S3 data access assets per revision',
            'LimitValue' => <float>,
            'Message' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => 'REVISION|ASSET|DATA_SET',
        ],
        // ...
    ],
    'Id' => '<string>',
    'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL|EXPORT_REVISIONS_TO_S3|IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES|IMPORT_ASSET_FROM_API_GATEWAY_API|CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET|IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

CreateRevision

$result = $client->createRevision([/* ... */]);
$promise = $client->createRevisionAsync([/* ... */]);

This operation creates a revision for a data set.

Parameter Syntax

$result = $client->createRevision([
    'Comment' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'RevocationComment' => '<string>',
    'Revoked' => true || false,
    'RevokedAt' => <DateTime>,
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

DeleteAsset

$result = $client->deleteAsset([/* ... */]);
$promise = $client->deleteAssetAsync([/* ... */]);

This operation deletes an asset.

Parameter Syntax

$result = $client->deleteAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

DeleteDataGrant

$result = $client->deleteDataGrant([/* ... */]);
$promise = $client->deleteDataGrantAsync([/* ... */]);

This operation deletes a data grant.

Parameter Syntax

$result = $client->deleteDataGrant([
    'DataGrantId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

DeleteDataSet

$result = $client->deleteDataSet([/* ... */]);
$promise = $client->deleteDataSetAsync([/* ... */]);

This operation deletes a data set.

Parameter Syntax

$result = $client->deleteDataSet([
    'DataSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

DeleteEventAction

$result = $client->deleteEventAction([/* ... */]);
$promise = $client->deleteEventActionAsync([/* ... */]);

This operation deletes the event action.

Parameter Syntax

$result = $client->deleteEventAction([
    'EventActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

DeleteRevision

$result = $client->deleteRevision([/* ... */]);
$promise = $client->deleteRevisionAsync([/* ... */]);

This operation deletes a revision.

Parameter Syntax

$result = $client->deleteRevision([
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetAsset

$result = $client->getAsset([/* ... */]);
$promise = $client->getAssetAsync([/* ... */]);

This operation returns information about an asset.

Parameter Syntax

$result = $client->getAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'AssetDetails' => [
        'ApiGatewayApiAsset' => [
            'ApiDescription' => '<string>',
            'ApiEndpoint' => '<string>',
            'ApiId' => '<string>',
            'ApiKey' => '<string>',
            'ApiName' => '<string>',
            'ApiSpecificationDownloadUrl' => '<string>',
            'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
            'ProtocolType' => 'REST',
            'Stage' => '<string>',
        ],
        'LakeFormationDataPermissionAsset' => [
            'LakeFormationDataPermissionDetails' => [
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'ResourceDetails' => [
                        'Database' => [
                            'Expression' => [
                                [
                                    'TagKey' => '<string>',
                                    'TagValues' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        'Table' => [
                            'Expression' => [
                                [
                                    'TagKey' => '<string>',
                                    'TagValues' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'ResourceType' => 'TABLE|DATABASE',
                ],
            ],
            'LakeFormationDataPermissionType' => 'LFTagPolicy',
            'Permissions' => ['<string>', ...],
            'RoleArn' => '<string>',
        ],
        'RedshiftDataShareAsset' => [
            'Arn' => '<string>',
        ],
        'S3DataAccessAsset' => [
            'Bucket' => '<string>',
            'KeyPrefixes' => ['<string>', ...],
            'Keys' => ['<string>', ...],
            'KmsKeysToGrant' => [
                [
                    'KmsKeyArn' => '<string>',
                ],
                // ...
            ],
            'S3AccessPointAlias' => '<string>',
            'S3AccessPointArn' => '<string>',
        ],
        'S3SnapshotAsset' => [
            'Size' => <float>,
        ],
    ],
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetDataGrant

$result = $client->getDataGrant([/* ... */]);
$promise = $client->getDataGrantAsync([/* ... */]);

This operation returns information about a data grant.

Parameter Syntax

$result = $client->getDataGrant([
    'DataGrantId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
    'AcceptedAt' => <DateTime>,
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Description' => '<string>',
    'EndsAt' => <DateTime>,
    'GrantDistributionScope' => 'AWS_ORGANIZATION|NONE',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReceiverPrincipal' => '<string>',
    'SenderPrincipal' => '<string>',
    'SourceDataSetId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetDataSet

$result = $client->getDataSet([/* ... */]);
$promise = $client->getDataSetAsync([/* ... */]);

This operation returns information about a data set.

Parameter Syntax

$result = $client->getDataSet([
    'DataSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'DataGrantId' => '<string>',
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetEventAction

$result = $client->getEventAction([/* ... */]);
$promise = $client->getEventActionAsync([/* ... */]);

This operation retrieves information about an event action.

Parameter Syntax

$result = $client->getEventAction([
    'EventActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Action' => [
        'ExportRevisionToS3' => [
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionDestination' => [
                'Bucket' => '<string>',
                'KeyPattern' => '<string>',
            ],
        ],
    ],
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Event' => [
        'RevisionPublished' => [
            'DataSetId' => '<string>',
        ],
    ],
    'Id' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetJob

$result = $client->getJob([/* ... */]);
$promise = $client->getJobAsync([/* ... */]);

This operation returns information about a job.

Parameter Syntax

$result = $client->getJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Details' => [
        'CreateS3DataAccessFromS3Bucket' => [
            'AssetSource' => [
                'Bucket' => '<string>',
                'KeyPrefixes' => ['<string>', ...],
                'Keys' => ['<string>', ...],
                'KmsKeysToGrant' => [
                    [
                        'KmsKeyArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
        'ExportAssetToSignedUrl' => [
            'AssetId' => '<string>',
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ExportAssetsToS3' => [
            'AssetDestinations' => [
                [
                    'AssetId' => '<string>',
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionId' => '<string>',
        ],
        'ExportRevisionsToS3' => [
            'DataSetId' => '<string>',
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'EventActionArn' => '<string>',
            'RevisionDestinations' => [
                [
                    'Bucket' => '<string>',
                    'KeyPattern' => '<string>',
                    'RevisionId' => '<string>',
                ],
                // ...
            ],
        ],
        'ImportAssetFromApiGatewayApi' => [
            'ApiDescription' => '<string>',
            'ApiId' => '<string>',
            'ApiKey' => '<string>',
            'ApiName' => '<string>',
            'ApiSpecificationMd5Hash' => '<string>',
            'ApiSpecificationUploadUrl' => '<string>',
            'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
            'DataSetId' => '<string>',
            'ProtocolType' => 'REST',
            'RevisionId' => '<string>',
            'Stage' => '<string>',
        ],
        'ImportAssetFromSignedUrl' => [
            'AssetName' => '<string>',
            'DataSetId' => '<string>',
            'Md5Hash' => '<string>',
            'RevisionId' => '<string>',
            'SignedUrl' => '<string>',
            'SignedUrlExpiresAt' => <DateTime>,
        ],
        'ImportAssetsFromLakeFormationTagPolicy' => [
            'CatalogId' => '<string>',
            'DataSetId' => '<string>',
            'Database' => [
                'Expression' => [
                    [
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...],
            ],
            'RevisionId' => '<string>',
            'RoleArn' => '<string>',
            'Table' => [
                'Expression' => [
                    [
                        'TagKey' => '<string>',
                        'TagValues' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Permissions' => ['<string>', ...],
            ],
        ],
        'ImportAssetsFromRedshiftDataShares' => [
            'AssetSources' => [
                [
                    'DataShareArn' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
        'ImportAssetsFromS3' => [
            'AssetSources' => [
                [
                    'Bucket' => '<string>',
                    'Key' => '<string>',
                ],
                // ...
            ],
            'DataSetId' => '<string>',
            'RevisionId' => '<string>',
        ],
    ],
    'Errors' => [
        [
            'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
            'Details' => [
                'ImportAssetFromSignedUrlJobErrorDetails' => [
                    'AssetName' => '<string>',
                ],
                'ImportAssetsFromS3JobErrorDetails' => [
                    [
                        'Bucket' => '<string>',
                        'Key' => '<string>',
                    ],
                    // ...
                ],
            ],
            'LimitName' => 'Assets per revision|Asset size in GB|Amazon Redshift datashare assets per revision|AWS Lake Formation data permission assets per revision|Amazon S3 data access assets per revision',
            'LimitValue' => <float>,
            'Message' => '<string>',
            'ResourceId' => '<string>',
            'ResourceType' => 'REVISION|ASSET|DATA_SET',
        ],
        // ...
    ],
    'Id' => '<string>',
    'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
    'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL|EXPORT_REVISIONS_TO_S3|IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES|IMPORT_ASSET_FROM_API_GATEWAY_API|CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET|IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetReceivedDataGrant

$result = $client->getReceivedDataGrant([/* ... */]);
$promise = $client->getReceivedDataGrantAsync([/* ... */]);

This operation returns information about a received data grant.

Parameter Syntax

$result = $client->getReceivedDataGrant([
    'DataGrantArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
    'AcceptedAt' => <DateTime>,
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Description' => '<string>',
    'EndsAt' => <DateTime>,
    'GrantDistributionScope' => 'AWS_ORGANIZATION|NONE',
    'Id' => '<string>',
    'Name' => '<string>',
    'ReceiverPrincipal' => '<string>',
    'SenderPrincipal' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

GetRevision

$result = $client->getRevision([/* ... */]);
$promise = $client->getRevisionAsync([/* ... */]);

This operation returns information about a revision.

Parameter Syntax

$result = $client->getRevision([
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'RevocationComment' => '<string>',
    'Revoked' => true || false,
    'RevokedAt' => <DateTime>,
    'SourceId' => '<string>',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListDataGrants

$result = $client->listDataGrants([/* ... */]);
$promise = $client->listDataGrantsAsync([/* ... */]);

This operation returns information about all data grants.

Parameter Syntax

$result = $client->listDataGrants([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataGrantSummaries' => [
        [
            'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
            'AcceptedAt' => <DateTime>,
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'EndsAt' => <DateTime>,
            'Id' => '<string>',
            'Name' => '<string>',
            'ReceiverPrincipal' => '<string>',
            'SenderPrincipal' => '<string>',
            'SourceDataSetId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListDataSetRevisions

$result = $client->listDataSetRevisions([/* ... */]);
$promise = $client->listDataSetRevisionsAsync([/* ... */]);

This operation lists a data set's revisions sorted by CreatedAt in descending order.

Parameter Syntax

$result = $client->listDataSetRevisions([
    'DataSetId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Revisions' => [
        [
            'Arn' => '<string>',
            'Comment' => '<string>',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'Finalized' => true || false,
            'Id' => '<string>',
            'RevocationComment' => '<string>',
            'Revoked' => true || false,
            'RevokedAt' => <DateTime>,
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListDataSets

$result = $client->listDataSets([/* ... */]);
$promise = $client->listDataSetsAsync([/* ... */]);

This operation lists your data sets. When listing by origin OWNED, results are sorted by CreatedAt in descending order. When listing by origin ENTITLED, there is no order.

Parameter Syntax

$result = $client->listDataSets([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Origin' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataSets' => [
        [
            'Arn' => '<string>',
            'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Origin' => 'OWNED|ENTITLED',
            'OriginDetails' => [
                'DataGrantId' => '<string>',
                'ProductId' => '<string>',
            ],
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListEventActions

$result = $client->listEventActions([/* ... */]);
$promise = $client->listEventActionsAsync([/* ... */]);

This operation lists your event actions.

Parameter Syntax

$result = $client->listEventActions([
    'EventSourceId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'EventActions' => [
        [
            'Action' => [
                'ExportRevisionToS3' => [
                    'Encryption' => [
                        'KmsKeyArn' => '<string>',
                        'Type' => 'aws:kms|AES256',
                    ],
                    'RevisionDestination' => [
                        'Bucket' => '<string>',
                        'KeyPattern' => '<string>',
                    ],
                ],
            ],
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Event' => [
                'RevisionPublished' => [
                    'DataSetId' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

This operation lists your jobs sorted by CreatedAt in descending order.

Parameter Syntax

$result = $client->listJobs([
    'DataSetId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RevisionId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Jobs' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Details' => [
                'CreateS3DataAccessFromS3Bucket' => [
                    'AssetSource' => [
                        'Bucket' => '<string>',
                        'KeyPrefixes' => ['<string>', ...],
                        'Keys' => ['<string>', ...],
                        'KmsKeysToGrant' => [
                            [
                                'KmsKeyArn' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                ],
                'ExportAssetToSignedUrl' => [
                    'AssetId' => '<string>',
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                    'SignedUrl' => '<string>',
                    'SignedUrlExpiresAt' => <DateTime>,
                ],
                'ExportAssetsToS3' => [
                    'AssetDestinations' => [
                        [
                            'AssetId' => '<string>',
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                        // ...
                    ],
                    'DataSetId' => '<string>',
                    'Encryption' => [
                        'KmsKeyArn' => '<string>',
                        'Type' => 'aws:kms|AES256',
                    ],
                    'RevisionId' => '<string>',
                ],
                'ExportRevisionsToS3' => [
                    'DataSetId' => '<string>',
                    'Encryption' => [
                        'KmsKeyArn' => '<string>',
                        'Type' => 'aws:kms|AES256',
                    ],
                    'EventActionArn' => '<string>',
                    'RevisionDestinations' => [
                        [
                            'Bucket' => '<string>',
                            'KeyPattern' => '<string>',
                            'RevisionId' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ImportAssetFromApiGatewayApi' => [
                    'ApiDescription' => '<string>',
                    'ApiId' => '<string>',
                    'ApiKey' => '<string>',
                    'ApiName' => '<string>',
                    'ApiSpecificationMd5Hash' => '<string>',
                    'ApiSpecificationUploadUrl' => '<string>',
                    'ApiSpecificationUploadUrlExpiresAt' => <DateTime>,
                    'DataSetId' => '<string>',
                    'ProtocolType' => 'REST',
                    'RevisionId' => '<string>',
                    'Stage' => '<string>',
                ],
                'ImportAssetFromSignedUrl' => [
                    'AssetName' => '<string>',
                    'DataSetId' => '<string>',
                    'Md5Hash' => '<string>',
                    'RevisionId' => '<string>',
                    'SignedUrl' => '<string>',
                    'SignedUrlExpiresAt' => <DateTime>,
                ],
                'ImportAssetsFromLakeFormationTagPolicy' => [
                    'CatalogId' => '<string>',
                    'DataSetId' => '<string>',
                    'Database' => [
                        'Expression' => [
                            [
                                'TagKey' => '<string>',
                                'TagValues' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Permissions' => ['<string>', ...],
                    ],
                    'RevisionId' => '<string>',
                    'RoleArn' => '<string>',
                    'Table' => [
                        'Expression' => [
                            [
                                'TagKey' => '<string>',
                                'TagValues' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'Permissions' => ['<string>', ...],
                    ],
                ],
                'ImportAssetsFromRedshiftDataShares' => [
                    'AssetSources' => [
                        [
                            'DataShareArn' => '<string>',
                        ],
                        // ...
                    ],
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                ],
                'ImportAssetsFromS3' => [
                    'AssetSources' => [
                        [
                            'Bucket' => '<string>',
                            'Key' => '<string>',
                        ],
                        // ...
                    ],
                    'DataSetId' => '<string>',
                    'RevisionId' => '<string>',
                ],
            ],
            'Errors' => [
                [
                    'Code' => 'ACCESS_DENIED_EXCEPTION|INTERNAL_SERVER_EXCEPTION|MALWARE_DETECTED|RESOURCE_NOT_FOUND_EXCEPTION|SERVICE_QUOTA_EXCEEDED_EXCEPTION|VALIDATION_EXCEPTION|MALWARE_SCAN_ENCRYPTED_FILE',
                    'Details' => [
                        'ImportAssetFromSignedUrlJobErrorDetails' => [
                            'AssetName' => '<string>',
                        ],
                        'ImportAssetsFromS3JobErrorDetails' => [
                            [
                                'Bucket' => '<string>',
                                'Key' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'LimitName' => 'Assets per revision|Asset size in GB|Amazon Redshift datashare assets per revision|AWS Lake Formation data permission assets per revision|Amazon S3 data access assets per revision',
                    'LimitValue' => <float>,
                    'Message' => '<string>',
                    'ResourceId' => '<string>',
                    'ResourceType' => 'REVISION|ASSET|DATA_SET',
                ],
                // ...
            ],
            'Id' => '<string>',
            'State' => 'WAITING|IN_PROGRESS|ERROR|COMPLETED|CANCELLED|TIMED_OUT',
            'Type' => 'IMPORT_ASSETS_FROM_S3|IMPORT_ASSET_FROM_SIGNED_URL|EXPORT_ASSETS_TO_S3|EXPORT_ASSET_TO_SIGNED_URL|EXPORT_REVISIONS_TO_S3|IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES|IMPORT_ASSET_FROM_API_GATEWAY_API|CREATE_S3_DATA_ACCESS_FROM_S3_BUCKET|IMPORT_ASSETS_FROM_LAKE_FORMATION_TAG_POLICY',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListReceivedDataGrants

$result = $client->listReceivedDataGrants([/* ... */]);
$promise = $client->listReceivedDataGrantsAsync([/* ... */]);

This operation returns information about all received data grants.

Parameter Syntax

$result = $client->listReceivedDataGrants([
    'AcceptanceState' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'DataGrantSummaries' => [
        [
            'AcceptanceState' => 'PENDING_RECEIVER_ACCEPTANCE|ACCEPTED',
            'AcceptedAt' => <DateTime>,
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'EndsAt' => <DateTime>,
            'Id' => '<string>',
            'Name' => '<string>',
            'ReceiverPrincipal' => '<string>',
            'SenderPrincipal' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListRevisionAssets

$result = $client->listRevisionAssets([/* ... */]);
$promise = $client->listRevisionAssetsAsync([/* ... */]);

This operation lists a revision's assets sorted alphabetically in descending order.

Parameter Syntax

$result = $client->listRevisionAssets([
    'DataSetId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Assets' => [
        [
            'Arn' => '<string>',
            'AssetDetails' => [
                'ApiGatewayApiAsset' => [
                    'ApiDescription' => '<string>',
                    'ApiEndpoint' => '<string>',
                    'ApiId' => '<string>',
                    'ApiKey' => '<string>',
                    'ApiName' => '<string>',
                    'ApiSpecificationDownloadUrl' => '<string>',
                    'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
                    'ProtocolType' => 'REST',
                    'Stage' => '<string>',
                ],
                'LakeFormationDataPermissionAsset' => [
                    'LakeFormationDataPermissionDetails' => [
                        'LFTagPolicy' => [
                            'CatalogId' => '<string>',
                            'ResourceDetails' => [
                                'Database' => [
                                    'Expression' => [
                                        [
                                            'TagKey' => '<string>',
                                            'TagValues' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                                'Table' => [
                                    'Expression' => [
                                        [
                                            'TagKey' => '<string>',
                                            'TagValues' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            'ResourceType' => 'TABLE|DATABASE',
                        ],
                    ],
                    'LakeFormationDataPermissionType' => 'LFTagPolicy',
                    'Permissions' => ['<string>', ...],
                    'RoleArn' => '<string>',
                ],
                'RedshiftDataShareAsset' => [
                    'Arn' => '<string>',
                ],
                'S3DataAccessAsset' => [
                    'Bucket' => '<string>',
                    'KeyPrefixes' => ['<string>', ...],
                    'Keys' => ['<string>', ...],
                    'KmsKeysToGrant' => [
                        [
                            'KmsKeyArn' => '<string>',
                        ],
                        // ...
                    ],
                    'S3AccessPointAlias' => '<string>',
                    'S3AccessPointArn' => '<string>',
                ],
                'S3SnapshotAsset' => [
                    'Size' => <float>,
                ],
            ],
            'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
            'CreatedAt' => <DateTime>,
            'DataSetId' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'RevisionId' => '<string>',
            'SourceId' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

This operation lists the tags on the resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

RevokeRevision

$result = $client->revokeRevision([/* ... */]);
$promise = $client->revokeRevisionAsync([/* ... */]);

This operation revokes subscribers' access to a revision.

Parameter Syntax

$result = $client->revokeRevision([
    'DataSetId' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
    'RevocationComment' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'RevocationComment' => '<string>',
    'Revoked' => true || false,
    'RevokedAt' => <DateTime>,
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

SendApiAsset

$result = $client->sendApiAsset([/* ... */]);
$promise = $client->sendApiAssetAsync([/* ... */]);

This operation invokes an API Gateway API asset. The request is proxied to the provider’s API Gateway API.

Parameter Syntax

$result = $client->sendApiAsset([
    'AssetId' => '<string>', // REQUIRED
    'Body' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Method' => '<string>',
    'Path' => '<string>',
    'QueryStringParameters' => ['<string>', ...],
    'RequestHeaders' => ['<string>', ...],
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Body' => '<string>',
    'ResponseHeaders' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

SendDataSetNotification

$result = $client->sendDataSetNotification([/* ... */]);
$promise = $client->sendDataSetNotificationAsync([/* ... */]);

The type of event associated with the data set.

Parameter Syntax

$result = $client->sendDataSetNotification([
    'ClientToken' => '<string>',
    'Comment' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Details' => [
        'DataUpdate' => [
            'DataUpdatedAt' => <integer || string || DateTime>,
        ],
        'Deprecation' => [
            'DeprecationAt' => <integer || string || DateTime>, // REQUIRED
        ],
        'SchemaChange' => [
            'Changes' => [
                [
                    'Description' => '<string>',
                    'Name' => '<string>', // REQUIRED
                    'Type' => 'ADD|REMOVE|MODIFY', // REQUIRED
                ],
                // ...
            ],
            'SchemaChangeAt' => <integer || string || DateTime>, // REQUIRED
        ],
    ],
    'Scope' => [
        'LakeFormationTagPolicies' => [
            [
                'Database' => '<string>',
                'Table' => '<string>',
            ],
            // ...
        ],
        'RedshiftDataShares' => [
            [
                'Arn' => '<string>', // REQUIRED
                'Database' => '<string>', // REQUIRED
                'Function' => '<string>',
                'Schema' => '<string>',
                'Table' => '<string>',
                'View' => '<string>',
            ],
            // ...
        ],
        'S3DataAccesses' => [
            [
                'KeyPrefixes' => ['<string>', ...],
                'Keys' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Type' => 'DATA_DELAY|DATA_UPDATE|DEPRECATION|SCHEMA_CHANGE', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

StartJob

$result = $client->startJob([/* ... */]);
$promise = $client->startJobAsync([/* ... */]);

This operation starts a job.

Parameter Syntax

$result = $client->startJob([
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

This operation tags a resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

This operation removes one or more tags from a resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UpdateAsset

$result = $client->updateAsset([/* ... */]);
$promise = $client->updateAssetAsync([/* ... */]);

This operation updates an asset.

Parameter Syntax

$result = $client->updateAsset([
    'AssetId' => '<string>', // REQUIRED
    'DataSetId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'AssetDetails' => [
        'ApiGatewayApiAsset' => [
            'ApiDescription' => '<string>',
            'ApiEndpoint' => '<string>',
            'ApiId' => '<string>',
            'ApiKey' => '<string>',
            'ApiName' => '<string>',
            'ApiSpecificationDownloadUrl' => '<string>',
            'ApiSpecificationDownloadUrlExpiresAt' => <DateTime>,
            'ProtocolType' => 'REST',
            'Stage' => '<string>',
        ],
        'LakeFormationDataPermissionAsset' => [
            'LakeFormationDataPermissionDetails' => [
                'LFTagPolicy' => [
                    'CatalogId' => '<string>',
                    'ResourceDetails' => [
                        'Database' => [
                            'Expression' => [
                                [
                                    'TagKey' => '<string>',
                                    'TagValues' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                        'Table' => [
                            'Expression' => [
                                [
                                    'TagKey' => '<string>',
                                    'TagValues' => ['<string>', ...],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    'ResourceType' => 'TABLE|DATABASE',
                ],
            ],
            'LakeFormationDataPermissionType' => 'LFTagPolicy',
            'Permissions' => ['<string>', ...],
            'RoleArn' => '<string>',
        ],
        'RedshiftDataShareAsset' => [
            'Arn' => '<string>',
        ],
        'S3DataAccessAsset' => [
            'Bucket' => '<string>',
            'KeyPrefixes' => ['<string>', ...],
            'Keys' => ['<string>', ...],
            'KmsKeysToGrant' => [
                [
                    'KmsKeyArn' => '<string>',
                ],
                // ...
            ],
            'S3AccessPointAlias' => '<string>',
            'S3AccessPointArn' => '<string>',
        ],
        'S3SnapshotAsset' => [
            'Size' => <float>,
        ],
    ],
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'RevisionId' => '<string>',
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

UpdateDataSet

$result = $client->updateDataSet([/* ... */]);
$promise = $client->updateDataSetAsync([/* ... */]);

This operation updates a data set.

Parameter Syntax

$result = $client->updateDataSet([
    'DataSetId' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'AssetType' => 'S3_SNAPSHOT|REDSHIFT_DATA_SHARE|API_GATEWAY_API|S3_DATA_ACCESS|LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt' => <DateTime>,
    'Description' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Origin' => 'OWNED|ENTITLED',
    'OriginDetails' => [
        'DataGrantId' => '<string>',
        'ProductId' => '<string>',
    ],
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

UpdateEventAction

$result = $client->updateEventAction([/* ... */]);
$promise = $client->updateEventActionAsync([/* ... */]);

This operation updates the event action.

Parameter Syntax

$result = $client->updateEventAction([
    'Action' => [
        'ExportRevisionToS3' => [
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256', // REQUIRED
            ],
            'RevisionDestination' => [ // REQUIRED
                'Bucket' => '<string>', // REQUIRED
                'KeyPattern' => '<string>',
            ],
        ],
    ],
    'EventActionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Action' => [
        'ExportRevisionToS3' => [
            'Encryption' => [
                'KmsKeyArn' => '<string>',
                'Type' => 'aws:kms|AES256',
            ],
            'RevisionDestination' => [
                'Bucket' => '<string>',
                'KeyPattern' => '<string>',
            ],
        ],
    ],
    'Arn' => '<string>',
    'CreatedAt' => <DateTime>,
    'Event' => [
        'RevisionPublished' => [
            'DataSetId' => '<string>',
        ],
    ],
    'Id' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.

UpdateRevision

$result = $client->updateRevision([/* ... */]);
$promise = $client->updateRevisionAsync([/* ... */]);

This operation updates a revision.

Parameter Syntax

$result = $client->updateRevision([
    'Comment' => '<string>',
    'DataSetId' => '<string>', // REQUIRED
    'Finalized' => true || false,
    'RevisionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Comment' => '<string>',
    'CreatedAt' => <DateTime>,
    'DataSetId' => '<string>',
    'Finalized' => true || false,
    'Id' => '<string>',
    'RevocationComment' => '<string>',
    'Revoked' => true || false,
    'RevokedAt' => <DateTime>,
    'SourceId' => '<string>',
    'UpdatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

The resource couldn't be found.

ThrottlingException:

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

AccessDeniedException:

Access to the resource is denied.

ConflictException:

The request couldn't be completed because it conflicted with the current state of the resource.

ValidationException:

The request was invalid.

InternalServerException:

An exception occurred with the service.