amazonka-cloudfront-2.0: Amazon CloudFront 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.CloudFront.ListCachePolicies

Description

Gets a list of cache policies.

You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Synopsis

Creating a Request

data ListCachePolicies Source #

See: newListCachePolicies smart constructor.

Constructors

ListCachePolicies' 

Fields

  • marker :: Maybe Text

    Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.

  • maxItems :: Maybe Text

    The maximum number of cache policies that you want in the response.

  • type' :: Maybe CachePolicyType

    A filter to return only the specified kinds of cache policies. Valid values are:

    • managed – Returns only the managed policies created by Amazon Web Services.
    • custom – Returns only the custom policies created in your Amazon Web Services account.

Instances

Instances details
ToHeaders ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

ToPath ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

ToQuery ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

AWSRequest ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Associated Types

type AWSResponse ListCachePolicies #

Generic ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Associated Types

type Rep ListCachePolicies :: Type -> Type #

Read ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Show ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

NFData ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Methods

rnf :: ListCachePolicies -> () #

Eq ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Hashable ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

type AWSResponse ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

type Rep ListCachePolicies Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

type Rep ListCachePolicies = D1 ('MetaData "ListCachePolicies" "Amazonka.CloudFront.ListCachePolicies" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "ListCachePolicies'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CachePolicyType)))))

newListCachePolicies :: ListCachePolicies Source #

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

ListCachePolicies, listCachePolicies_marker - Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.

ListCachePolicies, listCachePolicies_maxItems - The maximum number of cache policies that you want in the response.

ListCachePolicies, listCachePolicies_type - A filter to return only the specified kinds of cache policies. Valid values are:

  • managed – Returns only the managed policies created by Amazon Web Services.
  • custom – Returns only the custom policies created in your Amazon Web Services account.

Request Lenses

listCachePolicies_marker :: Lens' ListCachePolicies (Maybe Text) Source #

Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field's value to the value of NextMarker from the current page's response.

listCachePolicies_maxItems :: Lens' ListCachePolicies (Maybe Text) Source #

The maximum number of cache policies that you want in the response.

listCachePolicies_type :: Lens' ListCachePolicies (Maybe CachePolicyType) Source #

A filter to return only the specified kinds of cache policies. Valid values are:

  • managed – Returns only the managed policies created by Amazon Web Services.
  • custom – Returns only the custom policies created in your Amazon Web Services account.

Destructuring the Response

data ListCachePoliciesResponse Source #

See: newListCachePoliciesResponse smart constructor.

Constructors

ListCachePoliciesResponse' 

Fields

Instances

Instances details
Generic ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Associated Types

type Rep ListCachePoliciesResponse :: Type -> Type #

Read ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Show ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

NFData ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

Eq ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

type Rep ListCachePoliciesResponse Source # 
Instance details

Defined in Amazonka.CloudFront.ListCachePolicies

type Rep ListCachePoliciesResponse = D1 ('MetaData "ListCachePoliciesResponse" "Amazonka.CloudFront.ListCachePolicies" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "ListCachePoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cachePolicyList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CachePolicyList)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newListCachePoliciesResponse Source #

Create a value of ListCachePoliciesResponse 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:cachePolicyList:ListCachePoliciesResponse', listCachePoliciesResponse_cachePolicyList - A list of cache policies.

$sel:httpStatus:ListCachePoliciesResponse', listCachePoliciesResponse_httpStatus - The response's http status code.

Response Lenses