Skip to content

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

Description

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

Usage

machinelearning_describe_data_sources(FilterVariable, EQ, GT, LT, GE,
  LE, NE, Prefix, SortOrder, NextToken, Limit)

Arguments

  • FilterVariable

    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

    The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

  • GT

    The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

  • LT

    The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

  • GE

    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

    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

    The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

  • Prefix

    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

    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

    The ID of the page in the paginated results.

  • Limit

    The maximum number of DataSource to include in the result.

Value

A list with the following syntax:

list(
  Results = list(
    list(
      DataSourceId = "string",
      DataLocationS3 = "string",
      DataRearrangement = "string",
      CreatedByIamUser = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      DataSizeInBytes = 123,
      NumberOfFiles = 123,
      Name = "string",
      Status = "PENDING"|"INPROGRESS"|"FAILED"|"COMPLETED"|"DELETED",
      Message = "string",
      RedshiftMetadata = list(
        RedshiftDatabase = list(
          DatabaseName = "string",
          ClusterIdentifier = "string"
        ),
        DatabaseUserName = "string",
        SelectSqlQuery = "string"
      ),
      RDSMetadata = list(
        Database = list(
          InstanceIdentifier = "string",
          DatabaseName = "string"
        ),
        DatabaseUserName = "string",
        SelectSqlQuery = "string",
        ResourceRole = "string",
        ServiceRole = "string",
        DataPipelineId = "string"
      ),
      RoleARN = "string",
      ComputeStatistics = TRUE|FALSE,
      ComputeTime = 123,
      FinishedAt = as.POSIXct(
        "2015-01-01"
      ),
      StartedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$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
)