Module: Peddler::Types::DataKiosk20231115

Defined in:

lib/peddler/types/data_kiosk_2023_11_15/error.rb,
lib/peddler/types/data_kiosk_2023_11_15/query.rb,
lib/peddler/types/data_kiosk_2023_11_15/error_list.rb,
lib/peddler/types/data_kiosk_2023_11_15/get_queries_response.rb,
lib/peddler/types/data_kiosk_2023_11_15/create_query_response.rb,
lib/peddler/types/data_kiosk_2023_11_15/get_document_response.rb,
lib/peddler/types/data_kiosk_2023_11_15/create_query_specification.rb

Constant Summary

Error =

Error response returned when the request is unsuccessful.

Structure.new do
  # @return [String] An error code that identifies the type of error that occurred.
  attribute(:code, String)

  # @return [String] A message that describes the error condition.
  attribute(:message, String)

  # @return [String] Additional details that can help the caller understand or fix the issue.
  attribute(:details, String)
end

Query =

Detailed information about the query.

Structure.new do
  # @return [String] The query identifier. This identifier is unique only in combination with a selling partner
  # account ID.
  attribute(:query_id, String, from: "queryId")

  # @return [String] The submitted query.
  attribute(:query, String)

  # @return [String] The date and time when the query was created, in ISO 8601 date time format.
  attribute(:created_time, String, from: "createdTime")

  # @return [String] The processing status of the query.
  attribute(:processing_status, String, from: "processingStatus")

  # @return [String] The date and time when the query processing started, in ISO 8601 date time format.
  attribute(:processing_start_time, String, from: "processingStartTime")

  # @return [String] The date and time when the query processing completed, in ISO 8601 date time format.
  attribute(:processing_end_time, String, from: "processingEndTime")

  # @return [String] The data document identifier. This identifier is only present when there is data available as
  # a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass
  # this identifier into the `getDocument` operation to get the information required to retrieve the data
  # document's contents.
  attribute(:data_document_id, String, from: "dataDocumentId")

  # @return [String] The error document identifier. This identifier is only present when an error occurs during
  # query processing. This identifier is unique only in combination with a selling partner account ID. Pass this
  # identifier into the `getDocument` operation to get the information required to retrieve the error document's
  # contents.
  attribute(:error_document_id, String, from: "errorDocumentId")

  # @return [Hash] When a query produces results that are not included in the data document, pagination occurs.
  # This means the results are divided into pages. To retrieve the next page, you must pass a
  # `CreateQuerySpecification` object with `paginationToken` set to this object's `nextToken` and with `query` set
  # to this object's `query` in the subsequent `createQuery` request. When there are no more pages to fetch, the
  # `nextToken` field will be absent.
  attribute(:pagination, Hash)
end

ErrorList =

A list of error responses returned when a request is unsuccessful.

Structure.new do
  # @return [Array<Error>] Error response returned when the request is unsuccessful.
  attribute(:errors, [Error])
end

GetQueriesResponse =

The response for the getQueries operation.

Structure.new do
  # @return [Array<Query>] The Data Kiosk queries.
  attribute(:queries, [Query])

  # @return [Hash] When a request has results that are not included in this response, pagination occurs. This
  # means the results are divided into pages. To retrieve the next page, you must pass the `nextToken` as the
  # `paginationToken` query parameter in the subsequent `getQueries` request. All other parameters must be
  # provided with the same values that were provided with the request that generated this token, with the
  # exception of `pageSize` which can be modified between calls to `getQueries`. When there are no more pages to
  # fetch, the `nextToken` field will be absent.
  attribute(:pagination, Hash)
end

CreateQueryResponse =

The response for the createQuery operation.

Structure.new do
  # @return [String] The identifier for the query. This identifier is unique only in combination with a selling
  # partner account ID.
  attribute(:query_id, String, from: "queryId")
end

GetDocumentResponse =

The response for the getDocument operation.

Structure.new do
  # @return [String] The identifier for the Data Kiosk document. This identifier is unique only in combination
  # with a selling partner account ID.
  attribute(:document_id, String, from: "documentId")

  # @return [String] A presigned URL that can be used to retrieve the Data Kiosk document. This URL expires after
  # 5 minutes. If the Data Kiosk document is compressed, the `Content-Encoding` header will indicate the
  # compression algorithm.
  #
  # **Note:** Most HTTP clients are capable of automatically decompressing downloaded files based on the
  # `Content-Encoding` header.
  attribute(:document_url, String, from: "documentUrl")
end

CreateQuerySpecification =

Information required to create the query.

Structure.new do
  # @return [String] The GraphQL query to submit. A query must be at most 8000 characters after unnecessary
  # whitespace is removed.
  attribute(:query, String)

  # @return [String] A token to fetch a certain page of query results when there are multiple pages of query
  # results available. The value of this token must be fetched from the `pagination.nextToken` field of the
  # `Query` object, and the `query` field for this object must also be set to the `query` field of the same
  # `Query` object. A `Query` object can be retrieved from either the `getQueries` or `getQuery` operation. In the
  # absence of this token value, the first page of query results will be requested.
  attribute(:pagination_token, String, from: "paginationToken")
end