NeptuneGraph / Client / start_export_task

start_export_task#

NeptuneGraph.Client.start_export_task(**kwargs)#

Export data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE.

See also: AWS API Documentation

Request Syntax

response = client.start_export_task(
    graphIdentifier='string',
    roleArn='string',
    format='PARQUET'|'CSV',
    destination='string',
    kmsKeyIdentifier='string',
    parquetType='COLUMNAR',
    exportFilter={
        'vertexFilter': {
            'string': {
                'properties': {
                    'string': {
                        'outputType': 'string',
                        'sourcePropertyName': 'string',
                        'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                    }
                }
            }
        },
        'edgeFilter': {
            'string': {
                'properties': {
                    'string': {
                        'outputType': 'string',
                        'sourcePropertyName': 'string',
                        'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                    }
                }
            }
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • graphIdentifier (string) –

    [REQUIRED]

    The source graph identifier of the export task.

  • roleArn (string) –

    [REQUIRED]

    The ARN of the IAM role that will allow data to be exported to the destination.

  • format (string) –

    [REQUIRED]

    The format of the export task.

  • destination (string) –

    [REQUIRED]

    The Amazon S3 URI where data will be exported to.

  • kmsKeyIdentifier (string) –

    [REQUIRED]

    The KMS key identifier of the export task.

  • parquetType (string) – The parquet type of the export task.

  • exportFilter (dict) –

    The export filter of the export task.

    • vertexFilter (dict) –

      Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

      • (string) –

        • (dict) –

          Specifies whihc properties of that label should be included in the export.

          • properties (dict) –

            Each property is defined by a key-value pair, where the key is the desired output property name (e.g. “name”), and the value is an object.

            • (string) –

              • (dict) –

                A structure representing a property’s attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                • outputType (string) –

                  Specifies the data type to use for the property in the exported data (e.g. “String”, “Int”, “Float”). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has “height” stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                • sourcePropertyName (string) –

                  The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                • multiValueHandling (string) –

                  Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.

    • edgeFilter (dict) –

      Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

      • (string) –

        • (dict) –

          Specifies whihc properties of that label should be included in the export.

          • properties (dict) –

            Each property is defined by a key-value pair, where the key is the desired output property name (e.g. “name”), and the value is an object.

            • (string) –

              • (dict) –

                A structure representing a property’s attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                • outputType (string) –

                  Specifies the data type to use for the property in the exported data (e.g. “String”, “Int”, “Float”). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has “height” stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                • sourcePropertyName (string) –

                  The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                • multiValueHandling (string) –

                  Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.

  • tags (dict) –

    Tags to be applied to the export task.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'graphId': 'string',
    'roleArn': 'string',
    'taskId': 'string',
    'status': 'INITIALIZING'|'EXPORTING'|'SUCCEEDED'|'FAILED'|'CANCELLING'|'CANCELLED'|'DELETED',
    'format': 'PARQUET'|'CSV',
    'destination': 'string',
    'kmsKeyIdentifier': 'string',
    'parquetType': 'COLUMNAR',
    'statusReason': 'string',
    'exportFilter': {
        'vertexFilter': {
            'string': {
                'properties': {
                    'string': {
                        'outputType': 'string',
                        'sourcePropertyName': 'string',
                        'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                    }
                }
            }
        },
        'edgeFilter': {
            'string': {
                'properties': {
                    'string': {
                        'outputType': 'string',
                        'sourcePropertyName': 'string',
                        'multiValueHandling': 'TO_LIST'|'PICK_FIRST'
                    }
                }
            }
        }
    }
}

Response Structure

  • (dict) –

    • graphId (string) –

      The source graph identifier of the export task.

    • roleArn (string) –

      The ARN of the IAM role that will allow data to be exported to the destination.

    • taskId (string) –

      The unique identifier of the export task.

    • status (string) –

      The current status of the export task.

    • format (string) –

      The format of the export task.

    • destination (string) –

      The Amazon S3 URI of the export task where data will be exported to.

    • kmsKeyIdentifier (string) –

      The KMS key identifier of the export task.

    • parquetType (string) –

      The parquet type of the export task.

    • statusReason (string) –

      The reason that the export task has this status value.

    • exportFilter (dict) –

      The export filter of the export task.

      • vertexFilter (dict) –

        Used to specify filters on a per-label basis for vertices. This allows you to control which vertex labels and properties are included in the export.

        • (string) –

          • (dict) –

            Specifies whihc properties of that label should be included in the export.

            • properties (dict) –

              Each property is defined by a key-value pair, where the key is the desired output property name (e.g. “name”), and the value is an object.

              • (string) –

                • (dict) –

                  A structure representing a property’s attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                  • outputType (string) –

                    Specifies the data type to use for the property in the exported data (e.g. “String”, “Int”, “Float”). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has “height” stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                  • sourcePropertyName (string) –

                    The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                  • multiValueHandling (string) –

                    Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.

      • edgeFilter (dict) –

        Used to specify filters on a per-label basis for edges. This allows you to control which edge labels and properties are included in the export.

        • (string) –

          • (dict) –

            Specifies whihc properties of that label should be included in the export.

            • properties (dict) –

              Each property is defined by a key-value pair, where the key is the desired output property name (e.g. “name”), and the value is an object.

              • (string) –

                • (dict) –

                  A structure representing a property’s attributes. It is a map object of outputType, sourcePropertyName and multiValueHandling.

                  • outputType (string) –

                    Specifies the data type to use for the property in the exported data (e.g. “String”, “Int”, “Float”). If a type is not provided, the export process will determine the type. If a given property is present as multiple types (e.g. one vertex has “height” stored as a double, and another edge has it stored as a string), the type will be of Any type, otherwise, it will be the type of the property as present in vertices.

                  • sourcePropertyName (string) –

                    The name of the property as it exists in the original graph data. If not provided, it is assumed that the key matches the desired sourcePropertyName.

                  • multiValueHandling (string) –

                    Specifies how to handle properties that have multiple values. Can be either TO_LIST to export all values as a list, or PICK_FIRST to export the first value encountered. If not specified, the default value is PICK_FIRST.

Exceptions