amazonka-evidently-2.0: Amazon CloudWatch Evidently 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.Evidently.ListSegments

Description

Returns a list of audience segments that you have created in your account in this Region.

This operation returns paginated results.

Synopsis

Creating a Request

data ListSegments Source #

See: newListSegments smart constructor.

Constructors

ListSegments' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of results to include in the response. If you omit this, the default of 50 is used.

  • nextToken :: Maybe Text

    The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Instances

Instances details
ToHeaders ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

ToPath ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

ToQuery ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

AWSPager ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

AWSRequest ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Associated Types

type AWSResponse ListSegments #

Generic ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Associated Types

type Rep ListSegments :: Type -> Type #

Read ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Show ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

NFData ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Methods

rnf :: ListSegments -> () #

Eq ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Hashable ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

type AWSResponse ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

type Rep ListSegments Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

type Rep ListSegments = D1 ('MetaData "ListSegments" "Amazonka.Evidently.ListSegments" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "ListSegments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListSegments :: ListSegments Source #

Create a value of ListSegments 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:maxResults:ListSegments', listSegments_maxResults - The maximum number of results to include in the response. If you omit this, the default of 50 is used.

ListSegments, listSegments_nextToken - The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Request Lenses

listSegments_maxResults :: Lens' ListSegments (Maybe Natural) Source #

The maximum number of results to include in the response. If you omit this, the default of 50 is used.

listSegments_nextToken :: Lens' ListSegments (Maybe Text) Source #

The token to use when requesting the next set of results. You received this token from a previous ListSegments operation.

Destructuring the Response

data ListSegmentsResponse Source #

See: newListSegmentsResponse smart constructor.

Constructors

ListSegmentsResponse' 

Fields

  • nextToken :: Maybe Text

    The token to use in a subsequent ListSegments operation to return the next set of results.

  • segments :: Maybe [Segment]

    An array of structures that contain information about the segments in this Region.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Associated Types

type Rep ListSegmentsResponse :: Type -> Type #

Read ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Show ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

NFData ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

Methods

rnf :: ListSegmentsResponse -> () #

Eq ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

type Rep ListSegmentsResponse Source # 
Instance details

Defined in Amazonka.Evidently.ListSegments

type Rep ListSegmentsResponse = D1 ('MetaData "ListSegmentsResponse" "Amazonka.Evidently.ListSegments" "amazonka-evidently-2.0-Es2fJk98R0DAUPYaVkZSYC" 'False) (C1 ('MetaCons "ListSegmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "segments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Segment])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSegmentsResponse Source #

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

ListSegments, listSegmentsResponse_nextToken - The token to use in a subsequent ListSegments operation to return the next set of results.

$sel:segments:ListSegmentsResponse', listSegmentsResponse_segments - An array of structures that contain information about the segments in this Region.

$sel:httpStatus:ListSegmentsResponse', listSegmentsResponse_httpStatus - The response's http status code.

Response Lenses

listSegmentsResponse_nextToken :: Lens' ListSegmentsResponse (Maybe Text) Source #

The token to use in a subsequent ListSegments operation to return the next set of results.

listSegmentsResponse_segments :: Lens' ListSegmentsResponse (Maybe [Segment]) Source #

An array of structures that contain information about the segments in this Region.