DataExchange / Client / get_asset

get_asset

DataExchange.Client.get_asset(**kwargs)

This operation returns information about an asset.

See also: AWS API Documentation

Request Syntax

response = client.get_asset(
    AssetId='string',
    DataSetId='string',
    RevisionId='string'
)

Parameters:

• AssetId (string) –

  [REQUIRED]

  The unique identifier for an asset.

• DataSetId (string) –

  [REQUIRED]

  The unique identifier for a data set.

• RevisionId (string) –

  [REQUIRED]

  The unique identifier for a revision.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AssetDetails': {
        'S3SnapshotAsset': {
            'Size': 123.0
        },
        'RedshiftDataShareAsset': {
            'Arn': 'string'
        },
        'ApiGatewayApiAsset': {
            'ApiDescription': 'string',
            'ApiEndpoint': 'string',
            'ApiId': 'string',
            'ApiKey': 'string',
            'ApiName': 'string',
            'ApiSpecificationDownloadUrl': 'string',
            'ApiSpecificationDownloadUrlExpiresAt': datetime(2015, 1, 1),
            'ProtocolType': 'REST',
            'Stage': 'string'
        },
        'S3DataAccessAsset': {
            'Bucket': 'string',
            'KeyPrefixes': [
                'string',
            ],
            'Keys': [
                'string',
            ],
            'S3AccessPointAlias': 'string',
            'S3AccessPointArn': 'string',
            'KmsKeysToGrant': [
                {
                    'KmsKeyArn': 'string'
                },
            ]
        },
        'LakeFormationDataPermissionAsset': {
            'LakeFormationDataPermissionDetails': {
                'LFTagPolicy': {
                    'CatalogId': 'string',
                    'ResourceType': 'TABLE'|'DATABASE',
                    'ResourceDetails': {
                        'Database': {
                            'Expression': [
                                {
                                    'TagKey': 'string',
                                    'TagValues': [
                                        'string',
                                    ]
                                },
                            ]
                        },
                        'Table': {
                            'Expression': [
                                {
                                    'TagKey': 'string',
                                    'TagValues': [
                                        'string',
                                    ]
                                },
                            ]
                        }
                    }
                }
            },
            'LakeFormationDataPermissionType': 'LFTagPolicy',
            'Permissions': [
                'DESCRIBE'|'SELECT',
            ],
            'RoleArn': 'string'
        }
    },
    'AssetType': 'S3_SNAPSHOT'|'REDSHIFT_DATA_SHARE'|'API_GATEWAY_API'|'S3_DATA_ACCESS'|'LAKE_FORMATION_DATA_PERMISSION',
    'CreatedAt': datetime(2015, 1, 1),
    'DataSetId': 'string',
    'Id': 'string',
    'Name': 'string',
    'RevisionId': 'string',
    'SourceId': 'string',
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • Arn (string) –

    The ARN for the asset.

  • AssetDetails (dict) –

    Details about the asset.

    • S3SnapshotAsset (dict) –

      The Amazon S3 object that is the asset.

      • Size (float) –

        The size of the Amazon S3 object that is the object.

    • RedshiftDataShareAsset (dict) –

      The Amazon Redshift datashare that is the asset.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the datashare asset.

    • ApiGatewayApiAsset (dict) –

      Information about the API Gateway API asset.

      • ApiDescription (string) –

        The API description of the API asset.

      • ApiEndpoint (string) –

        The API endpoint of the API asset.

      • ApiId (string) –

        The unique identifier of the API asset.

      • ApiKey (string) –

        The API key of the API asset.

      • ApiName (string) –

        The API name of the API asset.

      • ApiSpecificationDownloadUrl (string) –

        The download URL of the API specification of the API asset.

      • ApiSpecificationDownloadUrlExpiresAt (datetime) –

        The date and time that the upload URL expires, in ISO 8601 format.

      • ProtocolType (string) –

        The protocol type of the API asset.

      • Stage (string) –

        The stage of the API asset.

    • S3DataAccessAsset (dict) –

      The Amazon S3 data access that is the asset.

      • Bucket (string) –

        The Amazon S3 bucket hosting data to be shared in the S3 data access.

      • KeyPrefixes (list) –

        The Amazon S3 bucket used for hosting shared data in the Amazon S3 data access.

        • (string) –

      • Keys (list) –

        S3 keys made available using this asset.

        • (string) –

      • S3AccessPointAlias (string) –

        The automatically-generated bucket-style alias for your Amazon S3 Access Point. Customers can access their entitled data using the S3 Access Point alias.

      • S3AccessPointArn (string) –

        The ARN for your Amazon S3 Access Point. Customers can also access their entitled data using the S3 Access Point ARN.

      • KmsKeysToGrant (list) –

        List of AWS KMS CMKs (Key Management System Customer Managed Keys) and ARNs used to encrypt S3 objects being shared in this S3 Data Access asset. Providers must include all AWS KMS keys used to encrypt these shared S3 objects.

        • (dict) –

          The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the shared S3 objects.

          • KmsKeyArn (string) –

            The AWS KMS CMK (Key Management System Customer Managed Key) used to encrypt S3 objects in the shared S3 Bucket. AWS Data exchange will create a KMS grant for each subscriber to allow them to access and decrypt their entitled data that is encrypted using this KMS key specified.

    • LakeFormationDataPermissionAsset (dict) –

      The AWS Lake Formation data permission that is the asset.

      • LakeFormationDataPermissionDetails (dict) –

        Details about the AWS Lake Formation data permission.

        • LFTagPolicy (dict) –

          Details about the LF-tag policy.

          • CatalogId (string) –

            The identifier for the AWS Glue Data Catalog.

          • ResourceType (string) –

            The resource type for which the LF-tag policy applies.

          • ResourceDetails (dict) –

            Details for the Lake Formation Resources included in the LF-tag policy.

            • Database (dict) –

              Details about the database resource included in the AWS Lake Formation data permission.

              • Expression (list) –

                A list of LF-tag conditions that apply to database resources.

                • (dict) –

                  A structure that allows an LF-admin to grant permissions on certain conditions.

                  • TagKey (string) –

                    The key name for the LF-tag.

                  • TagValues (list) –

                    A list of LF-tag values.

                    • (string) –

            • Table (dict) –

              Details about the table resource included in the AWS Lake Formation data permission.

              • Expression (list) –

                A list of LF-tag conditions that apply to table resources.

                • (dict) –

                  A structure that allows an LF-admin to grant permissions on certain conditions.

                  • TagKey (string) –

                    The key name for the LF-tag.

                  • TagValues (list) –

                    A list of LF-tag values.

                    • (string) –

      • LakeFormationDataPermissionType (string) –

        The data permission type.

      • Permissions (list) –

        The permissions granted to the subscribers on the resource.

        • (string) –

      • RoleArn (string) –

        The IAM role’s ARN that allows AWS Data Exchange to assume the role and grant and revoke permissions to AWS Lake Formation data permissions.

  • AssetType (string) –

    The type of asset that is added to a data set.

  • CreatedAt (datetime) –

    The date and time that the asset was created, in ISO 8601 format.

  • DataSetId (string) –

    The unique identifier for the data set associated with this asset.

  • Id (string) –

    The unique identifier for the asset.

  • Name (string) –

    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 the LF-tag policy” are used as the asset name.

  • RevisionId (string) –

    The unique identifier for the revision associated with this asset.

  • SourceId (string) –

    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.

  • UpdatedAt (datetime) –

    The date and time that the asset was last updated, in ISO 8601 format.

Exceptions

• DataExchange.Client.exceptions.ResourceNotFoundException

• DataExchange.Client.exceptions.ThrottlingException

• DataExchange.Client.exceptions.ValidationException

• DataExchange.Client.exceptions.InternalServerException