Amazonka.ECR.DescribePullThroughCacheRules

Returns the pull through cache rules for a registry.

This operation returns paginated results.

Creating a Request

data DescribePullThroughCacheRules

See: newDescribePullThroughCacheRules smart constructor.

Constructors

DescribePullThroughCacheRules'

Fields

• ecrRepositoryPrefixes :: Maybe (NonEmpty Text)

  The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

• maxResults :: Maybe Natural

  The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.

• nextToken :: Maybe Text

  The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

• registryId :: Maybe Text

  The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

Instances

ToJSON DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

toJSON :: DescribePullThroughCacheRules -> Value

toEncoding :: DescribePullThroughCacheRules -> Encoding

toJSONList :: [DescribePullThroughCacheRules] -> Value

toEncodingList :: [DescribePullThroughCacheRules] -> Encoding

ToHeaders DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

toHeaders :: DescribePullThroughCacheRules -> [Header]

ToPath DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

toPath :: DescribePullThroughCacheRules -> ByteString

ToQuery DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

toQuery :: DescribePullThroughCacheRules -> QueryString

AWSPager DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

page :: DescribePullThroughCacheRules -> AWSResponse DescribePullThroughCacheRules -> Maybe DescribePullThroughCacheRules

AWSRequest DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Associated Types

type AWSResponse DescribePullThroughCacheRules

Methods

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

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

Generic DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Associated Types

type Rep DescribePullThroughCacheRules :: Type -> Type

Methods

from :: DescribePullThroughCacheRules -> Rep DescribePullThroughCacheRules x

to :: Rep DescribePullThroughCacheRules x -> DescribePullThroughCacheRules

Read DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

readsPrec :: Int -> ReadS DescribePullThroughCacheRules

readList :: ReadS [DescribePullThroughCacheRules]

readPrec :: ReadPrec DescribePullThroughCacheRules

readListPrec :: ReadPrec [DescribePullThroughCacheRules]

Show DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

showsPrec :: Int -> DescribePullThroughCacheRules -> ShowS

show :: DescribePullThroughCacheRules -> String

showList :: [DescribePullThroughCacheRules] -> ShowS

NFData DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

rnf :: DescribePullThroughCacheRules -> ()

Eq DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

(==) :: DescribePullThroughCacheRules -> DescribePullThroughCacheRules -> Bool

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

Hashable DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

hashWithSalt :: Int -> DescribePullThroughCacheRules -> Int

hash :: DescribePullThroughCacheRules -> Int

type AWSResponse DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

type AWSResponse DescribePullThroughCacheRules = DescribePullThroughCacheRulesResponse

type Rep DescribePullThroughCacheRules

Defined in Amazonka.ECR.DescribePullThroughCacheRules

type Rep DescribePullThroughCacheRules = D1 ('MetaData "DescribePullThroughCacheRules" "Amazonka.ECR.DescribePullThroughCacheRules" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribePullThroughCacheRules'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ecrRepositoryPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribePullThroughCacheRules :: DescribePullThroughCacheRules

Create a value of DescribePullThroughCacheRules 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:ecrRepositoryPrefixes:DescribePullThroughCacheRules', describePullThroughCacheRules_ecrRepositoryPrefixes - The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

$sel:maxResults:DescribePullThroughCacheRules', describePullThroughCacheRules_maxResults - The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.

DescribePullThroughCacheRules, describePullThroughCacheRules_nextToken - The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

DescribePullThroughCacheRules, describePullThroughCacheRules_registryId - The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

Request Lenses

describePullThroughCacheRules_ecrRepositoryPrefixes :: Lens' DescribePullThroughCacheRules (Maybe (NonEmpty Text))

The Amazon ECR repository prefixes associated with the pull through cache rules to return. If no repository prefix value is specified, all pull through cache rules are returned.

describePullThroughCacheRules_maxResults :: Lens' DescribePullThroughCacheRules (Maybe Natural)

The maximum number of pull through cache rules returned by DescribePullThroughCacheRulesRequest in paginated output. When this parameter is used, DescribePullThroughCacheRulesRequest only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribePullThroughCacheRulesRequest request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribePullThroughCacheRulesRequest returns up to 100 results and a nextToken value, if applicable.

describePullThroughCacheRules_nextToken :: Lens' DescribePullThroughCacheRules (Maybe Text)

The nextToken value returned from a previous paginated DescribePullThroughCacheRulesRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

describePullThroughCacheRules_registryId :: Lens' DescribePullThroughCacheRules (Maybe Text)

The Amazon Web Services account ID associated with the registry to return the pull through cache rules for. If you do not specify a registry, the default registry is assumed.

Destructuring the Response

data DescribePullThroughCacheRulesResponse

See: newDescribePullThroughCacheRulesResponse smart constructor.

Constructors

DescribePullThroughCacheRulesResponse'

Fields

• nextToken :: Maybe Text

  The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

• pullThroughCacheRules :: Maybe [PullThroughCacheRule]

  The details of the pull through cache rules.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Associated Types

type Rep DescribePullThroughCacheRulesResponse :: Type -> Type

Methods

from :: DescribePullThroughCacheRulesResponse -> Rep DescribePullThroughCacheRulesResponse x

to :: Rep DescribePullThroughCacheRulesResponse x -> DescribePullThroughCacheRulesResponse

Read DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

readsPrec :: Int -> ReadS DescribePullThroughCacheRulesResponse

readList :: ReadS [DescribePullThroughCacheRulesResponse]

readPrec :: ReadPrec DescribePullThroughCacheRulesResponse

readListPrec :: ReadPrec [DescribePullThroughCacheRulesResponse]

Show DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

showsPrec :: Int -> DescribePullThroughCacheRulesResponse -> ShowS

show :: DescribePullThroughCacheRulesResponse -> String

showList :: [DescribePullThroughCacheRulesResponse] -> ShowS

NFData DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

rnf :: DescribePullThroughCacheRulesResponse -> ()

Eq DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

Methods

(==) :: DescribePullThroughCacheRulesResponse -> DescribePullThroughCacheRulesResponse -> Bool

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

type Rep DescribePullThroughCacheRulesResponse

Defined in Amazonka.ECR.DescribePullThroughCacheRules

type Rep DescribePullThroughCacheRulesResponse = D1 ('MetaData "DescribePullThroughCacheRulesResponse" "Amazonka.ECR.DescribePullThroughCacheRules" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribePullThroughCacheRulesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pullThroughCacheRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PullThroughCacheRule])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribePullThroughCacheRulesResponse

Arguments

:: Int

$sel:httpStatus:DescribePullThroughCacheRulesResponse'

-> DescribePullThroughCacheRulesResponse

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

DescribePullThroughCacheRules, describePullThroughCacheRulesResponse_nextToken - The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:pullThroughCacheRules:DescribePullThroughCacheRulesResponse', describePullThroughCacheRulesResponse_pullThroughCacheRules - The details of the pull through cache rules.

$sel:httpStatus:DescribePullThroughCacheRulesResponse', describePullThroughCacheRulesResponse_httpStatus - The response's http status code.

Response Lenses

describePullThroughCacheRulesResponse_nextToken :: Lens' DescribePullThroughCacheRulesResponse (Maybe Text)

The nextToken value to include in a future DescribePullThroughCacheRulesRequest request. When the results of a DescribePullThroughCacheRulesRequest request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

describePullThroughCacheRulesResponse_pullThroughCacheRules :: Lens' DescribePullThroughCacheRulesResponse (Maybe [PullThroughCacheRule])

The details of the pull through cache rules.

describePullThroughCacheRulesResponse_httpStatus :: Lens' DescribePullThroughCacheRulesResponse Int

The response's http status code.