amazonka-clouddirectory-2.0: Amazon CloudDirectory SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudDirectory.ListIndex

Description

Lists objects attached to the specified index.

This operation returns paginated results.

Synopsis

Creating a Request

data ListIndex Source #

See: newListIndex smart constructor.

Constructors

ListIndex' 

Fields

Instances

Instances details
ToJSON ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

ToHeaders ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Methods

toHeaders :: ListIndex -> [Header] #

ToPath ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

ToQuery ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

AWSPager ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

AWSRequest ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Associated Types

type AWSResponse ListIndex #

Generic ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Associated Types

type Rep ListIndex :: Type -> Type #

Read ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Show ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

NFData ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Methods

rnf :: ListIndex -> () #

Eq ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Hashable ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

type AWSResponse ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

type Rep ListIndex Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

type Rep ListIndex = D1 ('MetaData "ListIndex" "Amazonka.CloudDirectory.ListIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListIndex'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "rangesOnIndexedValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ObjectAttributeRange])) :*: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))

newListIndex Source #

Create a value of ListIndex 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:consistencyLevel:ListIndex', listIndex_consistencyLevel - The consistency level to execute the request at.

ListIndex, listIndex_maxResults - The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

ListIndex, listIndex_nextToken - The pagination token.

ListIndex, listIndex_rangesOnIndexedValues - Specifies the ranges of indexed values that you want to query.

ListIndex, listIndex_directoryArn - The ARN of the directory that the index exists in.

ListIndex, listIndex_indexReference - The reference to the index to list.

Request Lenses

listIndex_consistencyLevel :: Lens' ListIndex (Maybe ConsistencyLevel) Source #

The consistency level to execute the request at.

listIndex_maxResults :: Lens' ListIndex (Maybe Natural) Source #

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

listIndex_rangesOnIndexedValues :: Lens' ListIndex (Maybe [ObjectAttributeRange]) Source #

Specifies the ranges of indexed values that you want to query.

listIndex_directoryArn :: Lens' ListIndex Text Source #

The ARN of the directory that the index exists in.

listIndex_indexReference :: Lens' ListIndex ObjectReference Source #

The reference to the index to list.

Destructuring the Response

data ListIndexResponse Source #

See: newListIndexResponse smart constructor.

Constructors

ListIndexResponse' 

Fields

Instances

Instances details
Generic ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Associated Types

type Rep ListIndexResponse :: Type -> Type #

Read ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Show ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

NFData ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

Methods

rnf :: ListIndexResponse -> () #

Eq ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

type Rep ListIndexResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIndex

type Rep ListIndexResponse = D1 ('MetaData "ListIndexResponse" "Amazonka.CloudDirectory.ListIndex" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListIndexResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IndexAttachment])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIndexResponse Source #

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

ListIndexResponse, listIndexResponse_indexAttachments - The objects and indexed values attached to the index.

ListIndex, listIndexResponse_nextToken - The pagination token.

$sel:httpStatus:ListIndexResponse', listIndexResponse_httpStatus - The response's http status code.

Response Lenses

listIndexResponse_indexAttachments :: Lens' ListIndexResponse (Maybe [IndexAttachment]) Source #

The objects and indexed values attached to the index.

listIndexResponse_httpStatus :: Lens' ListIndexResponse Int Source #

The response's http status code.