Class: Aws::ECR::Types::DescribePullThroughCacheRulesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb

Overview

Note:

When making an API call, you may pass DescribePullThroughCacheRulesRequest data as a hash:

{
  registry_id: "RegistryId",
  ecr_repository_prefixes: ["PullThroughCacheRuleRepositoryPrefix"],
  next_token: "NextToken",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ecr_repository_prefixesArray<String>

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.

Returns:

  • (Array<String>)


1188
1189
1190
1191
1192
1193
1194
1195
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1188

class DescribePullThroughCacheRulesRequest < Struct.new(
  :registry_id,
  :ecr_repository_prefixes,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)


1188
1189
1190
1191
1192
1193
1194
1195
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1188

class DescribePullThroughCacheRulesRequest < Struct.new(
  :registry_id,
  :ecr_repository_prefixes,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


1188
1189
1190
1191
1192
1193
1194
1195
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1188

class DescribePullThroughCacheRulesRequest < Struct.new(
  :registry_id,
  :ecr_repository_prefixes,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#registry_idString

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.

Returns:

  • (String)


1188
1189
1190
1191
1192
1193
1194
1195
# File 'gems/aws-sdk-ecr/lib/aws-sdk-ecr/types.rb', line 1188

class DescribePullThroughCacheRulesRequest < Struct.new(
  :registry_id,
  :ecr_repository_prefixes,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end