{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.MemoryDb.DescribeServiceUpdates -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Returns details of the service updates -- -- This operation returns paginated results. module Amazonka.MemoryDb.DescribeServiceUpdates ( -- * Creating a Request DescribeServiceUpdates (..), newDescribeServiceUpdates, -- * Request Lenses describeServiceUpdates_clusterNames, describeServiceUpdates_maxResults, describeServiceUpdates_nextToken, describeServiceUpdates_serviceUpdateName, describeServiceUpdates_status, -- * Destructuring the Response DescribeServiceUpdatesResponse (..), newDescribeServiceUpdatesResponse, -- * Response Lenses describeServiceUpdatesResponse_nextToken, describeServiceUpdatesResponse_serviceUpdates, describeServiceUpdatesResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.MemoryDb.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeServiceUpdates' smart constructor. data DescribeServiceUpdates = DescribeServiceUpdates' { -- | The list of cluster names to identify service updates to apply clusterNames :: Prelude.Maybe [Prelude.Text], -- | The maximum number of records to include in the response. If more -- records exist than the specified MaxResults value, a token is included -- in the response so that the remaining results can be retrieved. maxResults :: Prelude.Maybe Prelude.Int, -- | An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. nextToken :: Prelude.Maybe Prelude.Text, -- | The unique ID of the service update to describe. serviceUpdateName :: Prelude.Maybe Prelude.Text, -- | The status(es) of the service updates to filter on status :: Prelude.Maybe [ServiceUpdateStatus] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeServiceUpdates' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'clusterNames', 'describeServiceUpdates_clusterNames' - The list of cluster names to identify service updates to apply -- -- 'maxResults', 'describeServiceUpdates_maxResults' - The maximum number of records to include in the response. If more -- records exist than the specified MaxResults value, a token is included -- in the response so that the remaining results can be retrieved. -- -- 'nextToken', 'describeServiceUpdates_nextToken' - An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. -- -- 'serviceUpdateName', 'describeServiceUpdates_serviceUpdateName' - The unique ID of the service update to describe. -- -- 'status', 'describeServiceUpdates_status' - The status(es) of the service updates to filter on newDescribeServiceUpdates :: DescribeServiceUpdates newDescribeServiceUpdates = DescribeServiceUpdates' { clusterNames = Prelude.Nothing, maxResults = Prelude.Nothing, nextToken = Prelude.Nothing, serviceUpdateName = Prelude.Nothing, status = Prelude.Nothing } -- | The list of cluster names to identify service updates to apply describeServiceUpdates_clusterNames :: Lens.Lens' DescribeServiceUpdates (Prelude.Maybe [Prelude.Text]) describeServiceUpdates_clusterNames = Lens.lens (\DescribeServiceUpdates' {clusterNames} -> clusterNames) (\s@DescribeServiceUpdates' {} a -> s {clusterNames = a} :: DescribeServiceUpdates) Prelude.. Lens.mapping Lens.coerced -- | The maximum number of records to include in the response. If more -- records exist than the specified MaxResults value, a token is included -- in the response so that the remaining results can be retrieved. describeServiceUpdates_maxResults :: Lens.Lens' DescribeServiceUpdates (Prelude.Maybe Prelude.Int) describeServiceUpdates_maxResults = Lens.lens (\DescribeServiceUpdates' {maxResults} -> maxResults) (\s@DescribeServiceUpdates' {} a -> s {maxResults = a} :: DescribeServiceUpdates) -- | An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. describeServiceUpdates_nextToken :: Lens.Lens' DescribeServiceUpdates (Prelude.Maybe Prelude.Text) describeServiceUpdates_nextToken = Lens.lens (\DescribeServiceUpdates' {nextToken} -> nextToken) (\s@DescribeServiceUpdates' {} a -> s {nextToken = a} :: DescribeServiceUpdates) -- | The unique ID of the service update to describe. describeServiceUpdates_serviceUpdateName :: Lens.Lens' DescribeServiceUpdates (Prelude.Maybe Prelude.Text) describeServiceUpdates_serviceUpdateName = Lens.lens (\DescribeServiceUpdates' {serviceUpdateName} -> serviceUpdateName) (\s@DescribeServiceUpdates' {} a -> s {serviceUpdateName = a} :: DescribeServiceUpdates) -- | The status(es) of the service updates to filter on describeServiceUpdates_status :: Lens.Lens' DescribeServiceUpdates (Prelude.Maybe [ServiceUpdateStatus]) describeServiceUpdates_status = Lens.lens (\DescribeServiceUpdates' {status} -> status) (\s@DescribeServiceUpdates' {} a -> s {status = a} :: DescribeServiceUpdates) Prelude.. Lens.mapping Lens.coerced instance Core.AWSPager DescribeServiceUpdates where page rq rs | Core.stop ( rs Lens.^? describeServiceUpdatesResponse_nextToken Prelude.. Lens._Just ) = Prelude.Nothing | Core.stop ( rs Lens.^? describeServiceUpdatesResponse_serviceUpdates Prelude.. Lens._Just ) = Prelude.Nothing | Prelude.otherwise = Prelude.Just Prelude.$ rq Prelude.& describeServiceUpdates_nextToken Lens..~ rs Lens.^? describeServiceUpdatesResponse_nextToken Prelude.. Lens._Just instance Core.AWSRequest DescribeServiceUpdates where type AWSResponse DescribeServiceUpdates = DescribeServiceUpdatesResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeServiceUpdatesResponse' Prelude.<$> (x Data..?> "NextToken") Prelude.<*> (x Data..?> "ServiceUpdates" Core..!@ Prelude.mempty) Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeServiceUpdates where hashWithSalt _salt DescribeServiceUpdates' {..} = _salt `Prelude.hashWithSalt` clusterNames `Prelude.hashWithSalt` maxResults `Prelude.hashWithSalt` nextToken `Prelude.hashWithSalt` serviceUpdateName `Prelude.hashWithSalt` status instance Prelude.NFData DescribeServiceUpdates where rnf DescribeServiceUpdates' {..} = Prelude.rnf clusterNames `Prelude.seq` Prelude.rnf maxResults `Prelude.seq` Prelude.rnf nextToken `Prelude.seq` Prelude.rnf serviceUpdateName `Prelude.seq` Prelude.rnf status instance Data.ToHeaders DescribeServiceUpdates where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AmazonMemoryDB.DescribeServiceUpdates" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeServiceUpdates where toJSON DescribeServiceUpdates' {..} = Data.object ( Prelude.catMaybes [ ("ClusterNames" Data..=) Prelude.<$> clusterNames, ("MaxResults" Data..=) Prelude.<$> maxResults, ("NextToken" Data..=) Prelude.<$> nextToken, ("ServiceUpdateName" Data..=) Prelude.<$> serviceUpdateName, ("Status" Data..=) Prelude.<$> status ] ) instance Data.ToPath DescribeServiceUpdates where toPath = Prelude.const "/" instance Data.ToQuery DescribeServiceUpdates where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeServiceUpdatesResponse' smart constructor. data DescribeServiceUpdatesResponse = DescribeServiceUpdatesResponse' { -- | An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. nextToken :: Prelude.Maybe Prelude.Text, -- | A list of service updates serviceUpdates :: Prelude.Maybe [ServiceUpdate], -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeServiceUpdatesResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'nextToken', 'describeServiceUpdatesResponse_nextToken' - An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. -- -- 'serviceUpdates', 'describeServiceUpdatesResponse_serviceUpdates' - A list of service updates -- -- 'httpStatus', 'describeServiceUpdatesResponse_httpStatus' - The response's http status code. newDescribeServiceUpdatesResponse :: -- | 'httpStatus' Prelude.Int -> DescribeServiceUpdatesResponse newDescribeServiceUpdatesResponse pHttpStatus_ = DescribeServiceUpdatesResponse' { nextToken = Prelude.Nothing, serviceUpdates = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | An optional argument to pass in case the total number of records exceeds -- the value of MaxResults. If nextToken is returned, there are more -- results available. The value of nextToken is a unique pagination token -- for each page. Make the call again using the returned token to retrieve -- the next page. Keep all other arguments unchanged. describeServiceUpdatesResponse_nextToken :: Lens.Lens' DescribeServiceUpdatesResponse (Prelude.Maybe Prelude.Text) describeServiceUpdatesResponse_nextToken = Lens.lens (\DescribeServiceUpdatesResponse' {nextToken} -> nextToken) (\s@DescribeServiceUpdatesResponse' {} a -> s {nextToken = a} :: DescribeServiceUpdatesResponse) -- | A list of service updates describeServiceUpdatesResponse_serviceUpdates :: Lens.Lens' DescribeServiceUpdatesResponse (Prelude.Maybe [ServiceUpdate]) describeServiceUpdatesResponse_serviceUpdates = Lens.lens (\DescribeServiceUpdatesResponse' {serviceUpdates} -> serviceUpdates) (\s@DescribeServiceUpdatesResponse' {} a -> s {serviceUpdates = a} :: DescribeServiceUpdatesResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. describeServiceUpdatesResponse_httpStatus :: Lens.Lens' DescribeServiceUpdatesResponse Prelude.Int describeServiceUpdatesResponse_httpStatus = Lens.lens (\DescribeServiceUpdatesResponse' {httpStatus} -> httpStatus) (\s@DescribeServiceUpdatesResponse' {} a -> s {httpStatus = a} :: DescribeServiceUpdatesResponse) instance Prelude.NFData DescribeServiceUpdatesResponse where rnf DescribeServiceUpdatesResponse' {..} = Prelude.rnf nextToken `Prelude.seq` Prelude.rnf serviceUpdates `Prelude.seq` Prelude.rnf httpStatus