MachineLearning / Client / describe_data_sources

describe_data_sources#

MachineLearning.Client.describe_data_sources(**kwargs)#

Returns a list of DataSource that match the search criteria in the request.

See also: AWS API Documentation

Request Syntax

response = client.describe_data_sources(
    FilterVariable='CreatedAt'|'LastUpdatedAt'|'Status'|'Name'|'DataLocationS3'|'IAMUser',
    EQ='string',
    GT='string',
    LT='string',
    GE='string',
    LE='string',
    NE='string',
    Prefix='string',
    SortOrder='asc'|'dsc',
    NextToken='string',
    Limit=123
)
Parameters:

  • FilterVariable (string) –

    Use one of the following variables to filter a list of DataSource:

    • CreatedAt - Sets the search criteria to DataSource creation dates.

    • Status - Sets the search criteria to DataSource statuses.

    • Name - Sets the search criteria to the contents of DataSource Name.

    • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.

    • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.

  • EQ (string) – The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

  • GT (string) – The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

  • LT (string) – The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

  • GE (string) – The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

  • LE (string) – The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

  • NE (string) – The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

  • Prefix (string) –

    A string that is found at the beginning of a variable, such as Name or Id.

    For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

    • 2014-09

    • 2014-09-09

    • 2014-09-09-Holiday

  • SortOrder (string) –

    A two-value parameter that determines the sequence of the resulting list of DataSource.

    • asc - Arranges the list in ascending order (A-Z, 0-9).

    • dsc - Arranges the list in descending order (Z-A, 9-0).

    Results are sorted by FilterVariable.

  • NextToken (string) – The ID of the page in the paginated results.

  • Limit (integer) – The maximum number of DataSource to include in the result.

Return type:

dict

Returns:

Response Syntax

{
    'Results': [
        {
            'DataSourceId': 'string',
            'DataLocationS3': 'string',
            'DataRearrangement': 'string',
            'CreatedByIamUser': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'LastUpdatedAt': datetime(2015, 1, 1),
            'DataSizeInBytes': 123,
            'NumberOfFiles': 123,
            'Name': 'string',
            'Status': 'PENDING'|'INPROGRESS'|'FAILED'|'COMPLETED'|'DELETED',
            'Message': 'string',
            'RedshiftMetadata': {
                'RedshiftDatabase': {
                    'DatabaseName': 'string',
                    'ClusterIdentifier': 'string'
                },
                'DatabaseUserName': 'string',
                'SelectSqlQuery': 'string'
            },
            'RDSMetadata': {
                'Database': {
                    'InstanceIdentifier': 'string',
                    'DatabaseName': 'string'
                },
                'DatabaseUserName': 'string',
                'SelectSqlQuery': 'string',
                'ResourceRole': 'string',
                'ServiceRole': 'string',
                'DataPipelineId': 'string'
            },
            'RoleARN': 'string',
            'ComputeStatistics': True|False,
            'ComputeTime': 123,
            'FinishedAt': datetime(2015, 1, 1),
            'StartedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

    • Results (list) –

      A list of DataSource that meet the search criteria.

      • (dict) –

        Represents the output of the GetDataSource operation.

        The content consists of the detailed metadata and data file information and the current status of the DataSource.

        • DataSourceId (string) –

          The ID that is assigned to the DataSource during creation.

        • DataLocationS3 (string) –

          The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

        • DataRearrangement (string) –

          A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

        • CreatedByIamUser (string) –

          The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

        • CreatedAt (datetime) –

          The time that the DataSource was created. The time is expressed in epoch time.

        • LastUpdatedAt (datetime) –

          The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

        • DataSizeInBytes (integer) –

          The total number of observations contained in the data files that the DataSource references.

        • NumberOfFiles (integer) –

          The number of data files referenced by the DataSource.

        • Name (string) –

          A user-supplied name or description of the DataSource.

        • Status (string) –

          The current status of the DataSource. This element can have one of the following values:

          • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.

          • INPROGRESS - The creation process is underway.

          • FAILED - The request to create a DataSource did not run to completion. It is not usable.

          • COMPLETED - The creation process completed successfully.

          • DELETED - The DataSource is marked as deleted. It is not usable.

        • Message (string) –

          A description of the most recent details about creating the DataSource.

        • RedshiftMetadata (dict) –

          Describes the DataSource details specific to Amazon Redshift.

          • RedshiftDatabase (dict) –

            Describes the database details required to connect to an Amazon Redshift database.

            • DatabaseName (string) –

              The name of a database hosted on an Amazon Redshift cluster.

            • ClusterIdentifier (string) –

              The ID of an Amazon Redshift cluster.

          • DatabaseUserName (string) –

            A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.

          • SelectSqlQuery (string) –

            The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

        • RDSMetadata (dict) –

          The datasource details that are specific to Amazon RDS.

          • Database (dict) –

            The database details required to connect to an Amazon RDS.

            • InstanceIdentifier (string) –

              The ID of an RDS DB instance.

            • DatabaseName (string) –

              The name of a database hosted on an RDS DB instance.

          • DatabaseUserName (string) –

            The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.

          • SelectSqlQuery (string) –

            The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

          • ResourceRole (string) –

            The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

          • ServiceRole (string) –

            The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

          • DataPipelineId (string) –

            The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.

        • RoleARN (string) –

          The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.

        • ComputeStatistics (boolean) –

          The parameter is true if statistics need to be generated from the observation data.

        • ComputeTime (integer) –

          Long integer type that is a 64-bit signed number.

        • FinishedAt (datetime) –

          A timestamp represented in epoch time.

        • StartedAt (datetime) –

          A timestamp represented in epoch time.

    • NextToken (string) –

      An ID of the next page in the paginated results that indicates at least one more page follows.

Exceptions