Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.GetSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

Synopsis

data GetSnapshots = GetSnapshots' {
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- indexId :: Text
- interval :: Interval
- metricType :: MetricType
}
newGetSnapshots :: Text -> Interval -> MetricType -> GetSnapshots
getSnapshots_maxResults :: Lens' GetSnapshots (Maybe Int)
getSnapshots_nextToken :: Lens' GetSnapshots (Maybe Text)
getSnapshots_indexId :: Lens' GetSnapshots Text
getSnapshots_interval :: Lens' GetSnapshots Interval
getSnapshots_metricType :: Lens' GetSnapshots MetricType
data GetSnapshotsResponse = GetSnapshotsResponse' {
- nextToken :: Maybe Text
- snapShotTimeFilter :: Maybe TimeRange
- snapshotsData :: Maybe [[Text]]
- snapshotsDataHeader :: Maybe [Text]
- httpStatus :: Int
}
newGetSnapshotsResponse :: Int -> GetSnapshotsResponse
getSnapshotsResponse_nextToken :: Lens' GetSnapshotsResponse (Maybe Text)
getSnapshotsResponse_snapShotTimeFilter :: Lens' GetSnapshotsResponse (Maybe TimeRange)
getSnapshotsResponse_snapshotsData :: Lens' GetSnapshotsResponse (Maybe [[Text]])
getSnapshotsResponse_snapshotsDataHeader :: Lens' GetSnapshotsResponse (Maybe [Text])
getSnapshotsResponse_httpStatus :: Lens' GetSnapshotsResponse Int

Creating a Request

data GetSnapshots Source #

See: newGetSnapshots smart constructor.

Constructors

GetSnapshots'

Fields

maxResults :: Maybe Int
The maximum number of returned data for the metric.
nextToken :: Maybe Text
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.
indexId :: Text
The identifier of the index to get search metrics data.
interval :: Interval
The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:
- THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
- ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
- TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
- THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
- ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
- TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.
metricType :: MetricType
The metric you want to retrieve. You can specify only one metric per call.
For more information about the metrics you can view, see Gaining insights with search analytics.

Instances

Instances details

ToJSON GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods toJSON :: GetSnapshots -> Value # toEncoding :: GetSnapshots -> Encoding # toJSONList :: [GetSnapshots] -> Value # toEncodingList :: [GetSnapshots] -> Encoding #
ToHeaders GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods toHeaders :: GetSnapshots -> [Header] #
ToPath GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods toPath :: GetSnapshots -> ByteString #
ToQuery GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods toQuery :: GetSnapshots -> QueryString #
AWSRequest GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Associated Types type AWSResponse GetSnapshots # Methods request :: (Service -> Service) -> GetSnapshots -> Request GetSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSnapshots))) #
Generic GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Associated Types type Rep GetSnapshots :: Type -> Type # Methods from :: GetSnapshots -> Rep GetSnapshots x # to :: Rep GetSnapshots x -> GetSnapshots #
Read GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods readsPrec :: Int -> ReadS GetSnapshots # readList :: ReadS [GetSnapshots] # readPrec :: ReadPrec GetSnapshots # readListPrec :: ReadPrec [GetSnapshots] #
Show GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods showsPrec :: Int -> GetSnapshots -> ShowS # show :: GetSnapshots -> String # showList :: [GetSnapshots] -> ShowS #
NFData GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods rnf :: GetSnapshots -> () #
Eq GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods (==) :: GetSnapshots -> GetSnapshots -> Bool # (/=) :: GetSnapshots -> GetSnapshots -> Bool #
Hashable GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods hashWithSalt :: Int -> GetSnapshots -> Int # hash :: GetSnapshots -> Int #
type AWSResponse GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots type AWSResponse GetSnapshots = GetSnapshotsResponse
type Rep GetSnapshots Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots type Rep GetSnapshots = D1 ('MetaData "GetSnapshots" "Amazonka.Kendra.GetSnapshots" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "interval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Interval) :: S1 ('MetaSel ('Just "metricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MetricType)))))

newGetSnapshots Source #

Arguments

:: Text	`$sel:indexId:GetSnapshots'`
-> Interval	`$sel:interval:GetSnapshots'`
-> MetricType	`$sel:metricType:GetSnapshots'`
-> GetSnapshots

Create a value of GetSnapshots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSnapshots, getSnapshots_maxResults - The maximum number of returned data for the metric.

GetSnapshots, getSnapshots_nextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

$sel:indexId:GetSnapshots', getSnapshots_indexId - The identifier of the index to get search metrics data.

$sel:interval:GetSnapshots', getSnapshots_interval - The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:

THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.

$sel:metricType:GetSnapshots', getSnapshots_metricType - The metric you want to retrieve. You can specify only one metric per call.

For more information about the metrics you can view, see Gaining insights with search analytics.

Request Lenses

getSnapshots_maxResults :: Lens' GetSnapshots (Maybe Int) Source #

The maximum number of returned data for the metric.

getSnapshots_nextToken :: Lens' GetSnapshots (Maybe Text) Source #

If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of search metrics data.

getSnapshots_indexId :: Lens' GetSnapshots Text Source #

The identifier of the index to get search metrics data.

getSnapshots_interval :: Lens' GetSnapshots Interval Source #

The time interval or time window to get search metrics data. The time interval uses the time zone of your index. You can view data in the following time windows:

THIS_WEEK: The current week, starting on the Sunday and ending on the day before the current date.
ONE_WEEK_AGO: The previous week, starting on the Sunday and ending on the following Saturday.
TWO_WEEKS_AGO: The week before the previous week, starting on the Sunday and ending on the following Saturday.
THIS_MONTH: The current month, starting on the first day of the month and ending on the day before the current date.
ONE_MONTH_AGO: The previous month, starting on the first day of the month and ending on the last day of the month.
TWO_MONTHS_AGO: The month before the previous month, starting on the first day of the month and ending on last day of the month.

getSnapshots_metricType :: Lens' GetSnapshots MetricType Source #

The metric you want to retrieve. You can specify only one metric per call.

For more information about the metrics you can view, see Gaining insights with search analytics.

Destructuring the Response

data GetSnapshotsResponse Source #

See: newGetSnapshotsResponse smart constructor.

Constructors

GetSnapshotsResponse'

Fields

nextToken :: Maybe Text
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
snapShotTimeFilter :: Maybe TimeRange
The date-time for the beginning and end of the time window for the search metrics data.
snapshotsData :: Maybe [[Text]]
The search metrics data. The data returned depends on the metric type you requested.
snapshotsDataHeader :: Maybe [Text]
The column headers for the search metrics data.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Associated Types type Rep GetSnapshotsResponse :: Type -> Type # Methods from :: GetSnapshotsResponse -> Rep GetSnapshotsResponse x # to :: Rep GetSnapshotsResponse x -> GetSnapshotsResponse #
Read GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods readsPrec :: Int -> ReadS GetSnapshotsResponse # readList :: ReadS [GetSnapshotsResponse] # readPrec :: ReadPrec GetSnapshotsResponse # readListPrec :: ReadPrec [GetSnapshotsResponse] #
Show GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods showsPrec :: Int -> GetSnapshotsResponse -> ShowS # show :: GetSnapshotsResponse -> String # showList :: [GetSnapshotsResponse] -> ShowS #
NFData GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods rnf :: GetSnapshotsResponse -> () #
Eq GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots Methods (==) :: GetSnapshotsResponse -> GetSnapshotsResponse -> Bool # (/=) :: GetSnapshotsResponse -> GetSnapshotsResponse -> Bool #
type Rep GetSnapshotsResponse Source #
Instance details Defined in Amazonka.Kendra.GetSnapshots type Rep GetSnapshotsResponse = D1 ('MetaData "GetSnapshotsResponse" "Amazonka.Kendra.GetSnapshots" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetSnapshotsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "snapShotTimeFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeRange))) :: (S1 ('MetaSel ('Just "snapshotsData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [[Text]])) :: (S1 ('MetaSel ('Just "snapshotsDataHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSnapshotsResponse'`
-> GetSnapshotsResponse

Create a value of GetSnapshotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSnapshots, getSnapshotsResponse_nextToken - If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

$sel:snapShotTimeFilter:GetSnapshotsResponse', getSnapshotsResponse_snapShotTimeFilter - The date-time for the beginning and end of the time window for the search metrics data.

$sel:snapshotsData:GetSnapshotsResponse', getSnapshotsResponse_snapshotsData - The search metrics data. The data returned depends on the metric type you requested.

$sel:snapshotsDataHeader:GetSnapshotsResponse', getSnapshotsResponse_snapshotsDataHeader - The column headers for the search metrics data.

$sel:httpStatus:GetSnapshotsResponse', getSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

getSnapshotsResponse_nextToken :: Lens' GetSnapshotsResponse (Maybe Text) Source #

If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.

getSnapshotsResponse_snapShotTimeFilter :: Lens' GetSnapshotsResponse (Maybe TimeRange) Source #

The date-time for the beginning and end of the time window for the search metrics data.

getSnapshotsResponse_snapshotsData :: Lens' GetSnapshotsResponse (Maybe [[Text]]) Source #

The search metrics data. The data returned depends on the metric type you requested.

getSnapshotsResponse_snapshotsDataHeader :: Lens' GetSnapshotsResponse (Maybe [Text]) Source #

The column headers for the search metrics data.

getSnapshotsResponse_httpStatus :: Lens' GetSnapshotsResponse Int Source #

The response's http status code.