Amazonka.ElasticSearch.DescribePackages

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Creating a Request

data DescribePackages

Container for request parameters to DescribePackage operation.

See: newDescribePackages smart constructor.

Constructors

DescribePackages'

Fields

• filters :: Maybe [DescribePackagesFilter]

  Only returns packages that match the DescribePackagesFilterList values.

• maxResults :: Maybe Int

  Limits results to a maximum number of packages.

• nextToken :: Maybe Text

  Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Instances

ToJSON DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

toJSON :: DescribePackages -> Value

toEncoding :: DescribePackages -> Encoding

toJSONList :: [DescribePackages] -> Value

toEncodingList :: [DescribePackages] -> Encoding

ToHeaders DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

toHeaders :: DescribePackages -> [Header]

ToPath DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

toPath :: DescribePackages -> ByteString

ToQuery DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

toQuery :: DescribePackages -> QueryString

AWSRequest DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Associated Types

type AWSResponse DescribePackages

Methods

request :: (Service -> Service) -> DescribePackages -> Request DescribePackages

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribePackages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribePackages)))

Generic DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Associated Types

type Rep DescribePackages :: Type -> Type

Methods

from :: DescribePackages -> Rep DescribePackages x

to :: Rep DescribePackages x -> DescribePackages

Read DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

readsPrec :: Int -> ReadS DescribePackages

readList :: ReadS [DescribePackages]

readPrec :: ReadPrec DescribePackages

readListPrec :: ReadPrec [DescribePackages]

Show DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

showsPrec :: Int -> DescribePackages -> ShowS

show :: DescribePackages -> String

showList :: [DescribePackages] -> ShowS

NFData DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

rnf :: DescribePackages -> ()

Eq DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

(==) :: DescribePackages -> DescribePackages -> Bool

(/=) :: DescribePackages -> DescribePackages -> Bool

Hashable DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

hashWithSalt :: Int -> DescribePackages -> Int

hash :: DescribePackages -> Int

type AWSResponse DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

type AWSResponse DescribePackages = DescribePackagesResponse

type Rep DescribePackages

Defined in Amazonka.ElasticSearch.DescribePackages

type Rep DescribePackages = D1 ('MetaData "DescribePackages" "Amazonka.ElasticSearch.DescribePackages" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "DescribePackages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DescribePackagesFilter])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribePackages :: DescribePackages

Create a value of DescribePackages 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:

$sel:filters:DescribePackages', describePackages_filters - Only returns packages that match the DescribePackagesFilterList values.

$sel:maxResults:DescribePackages', describePackages_maxResults - Limits results to a maximum number of packages.

DescribePackages, describePackages_nextToken - Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Request Lenses

describePackages_filters :: Lens' DescribePackages (Maybe [DescribePackagesFilter])

Only returns packages that match the DescribePackagesFilterList values.

describePackages_maxResults :: Lens' DescribePackages (Maybe Int)

Limits results to a maximum number of packages.

describePackages_nextToken :: Lens' DescribePackages (Maybe Text)

Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Destructuring the Response

data DescribePackagesResponse

Container for response returned by DescribePackages operation.

See: newDescribePackagesResponse smart constructor.

Constructors

DescribePackagesResponse'

Fields

• nextToken :: Maybe Text
• packageDetailsList :: Maybe [PackageDetails]

  List of PackageDetails objects.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

Associated Types

type Rep DescribePackagesResponse :: Type -> Type

Methods

from :: DescribePackagesResponse -> Rep DescribePackagesResponse x

to :: Rep DescribePackagesResponse x -> DescribePackagesResponse

Read DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

readsPrec :: Int -> ReadS DescribePackagesResponse

readList :: ReadS [DescribePackagesResponse]

readPrec :: ReadPrec DescribePackagesResponse

readListPrec :: ReadPrec [DescribePackagesResponse]

Show DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

showsPrec :: Int -> DescribePackagesResponse -> ShowS

show :: DescribePackagesResponse -> String

showList :: [DescribePackagesResponse] -> ShowS

NFData DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

rnf :: DescribePackagesResponse -> ()

Eq DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

Methods

(==) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool

(/=) :: DescribePackagesResponse -> DescribePackagesResponse -> Bool

type Rep DescribePackagesResponse

Defined in Amazonka.ElasticSearch.DescribePackages

type Rep DescribePackagesResponse = D1 ('MetaData "DescribePackagesResponse" "Amazonka.ElasticSearch.DescribePackages" "amazonka-elasticsearch-2.0-BmZjovliTfgJWgrJ3fCf5z" 'False) (C1 ('MetaCons "DescribePackagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "packageDetailsList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PackageDetails])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePackagesResponse

Arguments

:: Int

$sel:httpStatus:DescribePackagesResponse'

-> DescribePackagesResponse

Create a value of DescribePackagesResponse 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:

DescribePackages, describePackagesResponse_nextToken - Undocumented member.

$sel:packageDetailsList:DescribePackagesResponse', describePackagesResponse_packageDetailsList - List of PackageDetails objects.

$sel:httpStatus:DescribePackagesResponse', describePackagesResponse_httpStatus - The response's http status code.

Response Lenses

describePackagesResponse_nextToken :: Lens' DescribePackagesResponse (Maybe Text)

Undocumented member.

describePackagesResponse_packageDetailsList :: Lens' DescribePackagesResponse (Maybe [PackageDetails])

List of PackageDetails objects.

describePackagesResponse_httpStatus :: Lens' DescribePackagesResponse Int

The response's http status code.