class Aws::ECR::Client

See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::ECR::Client.new(
An API client for ECR. To construct a client, you need to configure a ‘:region` and `:credentials`.

def batch_check_layer_availability(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • batch_check_layer_availability(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchCheckLayerAvailability - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::BatchCheckLayerAvailabilityResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :layer_digests (required, Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def batch_check_layer_availability(params = {}, options = {})
  req = build_request(:batch_check_layer_availability, params)
  req.send_request(options)
end

def batch_delete_image(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • batch_delete_image(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchDeleteImage - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To delete multiple images -

Returns:
  • (Types::BatchDeleteImageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :image_ids (required, Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def batch_delete_image(params = {}, options = {})
  req = build_request(:batch_delete_image, params)
  req.send_request(options)
end

def batch_get_image(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • batch_get_image(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchGetImage - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To obtain multiple images in a single request -

Returns:
  • (Types::BatchGetImageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :accepted_media_types (Array) --
  • :image_ids (required, Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def batch_get_image(params = {}, options = {})
  req = build_request(:batch_get_image, params)
  req.send_request(options)
end

def batch_get_repository_scanning_configuration(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • batch_get_repository_scanning_configuration(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/BatchGetRepositoryScanningConfiguration - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::BatchGetRepositoryScanningConfigurationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_names (required, Array) --
def batch_get_repository_scanning_configuration(params = {}, options = {})
  req = build_request(:batch_get_repository_scanning_configuration, params)
  req.send_request(options)
end

def build_request(operation_name, params = {})

Other tags:
    Api: - private

Parameters:
  • params ({}) --
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-ecr'
  context[:gem_version] = '1.60.0'
  Seahorse::Client::Request.new(handlers, context)
end

def complete_layer_upload(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • complete_layer_upload(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/CompleteLayerUpload - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CompleteLayerUploadResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :layer_digests (required, Array) --
  • :upload_id (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def complete_layer_upload(params = {}, options = {})
  req = build_request(:complete_layer_upload, params)
  req.send_request(options)
end

def create_pull_through_cache_rule(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_pull_through_cache_rule(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/CreatePullThroughCacheRule - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreatePullThroughCacheRuleResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :registry_id (String) --
  • :upstream_registry_url (required, String) --
  • :ecr_repository_prefix (required, String) --
def create_pull_through_cache_rule(params = {}, options = {})
  req = build_request(:create_pull_through_cache_rule, params)
  req.send_request(options)
end

def create_repository(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_repository(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/CreateRepository - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To create a new repository -

Returns:
  • (Types::CreateRepositoryResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :encryption_configuration (Types::EncryptionConfiguration) --
  • :image_scanning_configuration (Types::ImageScanningConfiguration) --
  • :image_tag_mutability (String) --
  • :tags (Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def create_repository(params = {}, options = {})
  req = build_request(:create_repository, params)
  req.send_request(options)
end

def delete_lifecycle_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_lifecycle_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteLifecyclePolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeleteLifecyclePolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_name (required, String) --
  • :registry_id (String) --
def delete_lifecycle_policy(params = {}, options = {})
  req = build_request(:delete_lifecycle_policy, params)
  req.send_request(options)
end

def delete_pull_through_cache_rule(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_pull_through_cache_rule(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeletePullThroughCacheRule - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeletePullThroughCacheRuleResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :registry_id (String) --
  • :ecr_repository_prefix (required, String) --
def delete_pull_through_cache_rule(params = {}, options = {})
  req = build_request(:delete_pull_through_cache_rule, params)
  req.send_request(options)
end

def delete_registry_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_registry_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteRegistryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -

Returns:
  • (Types::DeleteRegistryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def delete_registry_policy(params = {}, options = {})
  req = build_request(:delete_registry_policy, params)
  req.send_request(options)
end

def delete_repository(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_repository(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteRepository - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To force delete a repository -

Returns:
  • (Types::DeleteRepositoryResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :force (Boolean) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def delete_repository(params = {}, options = {})
  req = build_request(:delete_repository, params)
  req.send_request(options)
end

def delete_repository_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_repository_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DeleteRepositoryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To delete the policy associated with a repository -

Returns:
  • (Types::DeleteRepositoryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_name (required, String) --
  • :registry_id (String) --
def delete_repository_policy(params = {}, options = {})
  req = build_request(:delete_repository_policy, params)
  req.send_request(options)
end

def describe_image_replication_status(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_image_replication_status(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImageReplicationStatus - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeImageReplicationStatusResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :registry_id (String) --
  • :image_id (required, Types::ImageIdentifier) --
  • :repository_name (required, String) --
def describe_image_replication_status(params = {}, options = {})
  req = build_request(:describe_image_replication_status, params)
  req.send_request(options)
end

def describe_image_scan_findings(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_image_scan_findings(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImageScanFindings - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeImageScanFindingsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
  • :image_id (required, Types::ImageIdentifier) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def describe_image_scan_findings(params = {}, options = {})
  req = build_request(:describe_image_scan_findings, params)
  req.send_request(options)
end

def describe_images(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_images(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeImages - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeImagesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :filter (Types::DescribeImagesFilter) --
  • :max_results (Integer) --
  • :next_token (String) --
  • :image_ids (Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def describe_images(params = {}, options = {})
  req = build_request(:describe_images, params)
  req.send_request(options)
end

def describe_pull_through_cache_rules(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_pull_through_cache_rules(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribePullThroughCacheRules - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribePullThroughCacheRulesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
  • :ecr_repository_prefixes (Array) --
  • :registry_id (String) --
def describe_pull_through_cache_rules(params = {}, options = {})
  req = build_request(:describe_pull_through_cache_rules, params)
  req.send_request(options)
end

def describe_registry(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_registry(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeRegistry - AWS API Documentation

Other tags:
    Example: Response structure -

Returns:
  • (Types::DescribeRegistryResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def describe_registry(params = {}, options = {})
  req = build_request(:describe_registry, params)
  req.send_request(options)
end

def describe_repositories(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_repositories(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/DescribeRepositories - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To describe all repositories in the current account -

Returns:
  • (Types::DescribeRepositoriesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :max_results (Integer) --
  • :next_token (String) --
  • :repository_names (Array) --
  • :registry_id (String) --
def describe_repositories(params = {}, options = {})
  req = build_request(:describe_repositories, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private
def errors_module
  Errors
end

def get_authorization_token(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_authorization_token(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetAuthorizationToken - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To obtain an authorization token -

Returns:
  • (Types::GetAuthorizationTokenResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :registry_ids (Array) --
def get_authorization_token(params = {}, options = {})
  req = build_request(:get_authorization_token, params)
  req.send_request(options)
end

def get_download_url_for_layer(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_download_url_for_layer(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetDownloadUrlForLayer - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetDownloadUrlForLayerResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :layer_digest (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def get_download_url_for_layer(params = {}, options = {})
  req = build_request(:get_download_url_for_layer, params)
  req.send_request(options)
end

def get_lifecycle_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_lifecycle_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetLifecyclePolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetLifecyclePolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_name (required, String) --
  • :registry_id (String) --
def get_lifecycle_policy(params = {}, options = {})
  req = build_request(:get_lifecycle_policy, params)
  req.send_request(options)
end

def get_lifecycle_policy_preview(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_lifecycle_policy_preview(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetLifecyclePolicyPreview - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetLifecyclePolicyPreviewResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :filter (Types::LifecyclePolicyPreviewFilter) --
  • :max_results (Integer) --
  • :next_token (String) --
  • :image_ids (Array) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def get_lifecycle_policy_preview(params = {}, options = {})
  req = build_request(:get_lifecycle_policy_preview, params)
  req.send_request(options)
end

def get_registry_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_registry_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetRegistryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -

Returns:
  • (Types::GetRegistryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def get_registry_policy(params = {}, options = {})
  req = build_request(:get_registry_policy, params)
  req.send_request(options)
end

def get_registry_scanning_configuration(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_registry_scanning_configuration(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetRegistryScanningConfiguration - AWS API Documentation

Other tags:
    Example: Response structure -

Returns:
  • (Types::GetRegistryScanningConfigurationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:
def get_registry_scanning_configuration(params = {}, options = {})
  req = build_request(:get_registry_scanning_configuration, params)
  req.send_request(options)
end

def get_repository_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_repository_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/GetRepositoryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To get the current policy for a repository -

Returns:
  • (Types::GetRepositoryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_name (required, String) --
  • :registry_id (String) --
def get_repository_policy(params = {}, options = {})
  req = build_request(:get_repository_policy, params)
  req.send_request(options)
end

def initialize(*args)

Options Hash: (**options)
  • :ssl_ca_directory (String) -- Full path of the
  • :ssl_ca_bundle (String) -- Full path to the SSL
  • :ssl_verify_peer (Boolean) -- When `true`,
  • :http_wire_trace (Boolean) -- When `true`,
  • :ssl_timeout (Float) -- Sets the SSL timeout
  • :http_continue_timeout (Float) -- The number of
  • :http_idle_timeout (Float) -- The number of
  • :http_read_timeout (Float) -- The default
  • :http_open_timeout (Float) -- The number of
  • :http_proxy (URI::HTTP, String) -- A proxy to send
  • :endpoint_provider (Aws::ECR::EndpointProvider) --
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :token_provider (Aws::TokenProvider) --
  • :stub_responses (Boolean) --
  • :simple_json (Boolean) --
  • :session_token (String) --
  • :secret_access_key (String) --
  • :sdk_ua_app_id (String) --
  • :retry_mode (String) --
  • :retry_max_delay (Integer) --
  • :retry_limit (Integer) --
  • :retry_jitter (Symbol) --
  • :retry_base_delay (Float) --
  • :retry_backoff (Proc) --
  • :profile (String) --
  • :max_attempts (Integer) --
  • :logger (Logger) --
  • :log_level (Symbol) --
  • :log_formatter (Aws::Log::Formatter) --
  • :endpoint_discovery (Boolean) --
  • :endpoint_cache_poll_interval (Integer) --
  • :endpoint_cache_max_threads (Integer) --
  • :endpoint_cache_max_entries (Integer) --
  • :endpoint (String) --
  • :disable_host_prefix_injection (Boolean) --
  • :defaults_mode (String) --
  • :correct_clock_skew (Boolean) --
  • :convert_params (Boolean) --
  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) --
  • :client_side_monitoring_port (Integer) --
  • :client_side_monitoring_host (String) --
  • :client_side_monitoring_client_id (String) --
  • :client_side_monitoring (Boolean) --
  • :adaptive_retry_wait_to_fill (Boolean) --
  • :active_endpoint_cache (Boolean) --
  • :access_key_id (String) --
  • :region (required, String) --
  • :credentials (required, Aws::CredentialProvider) --

Other tags:
    See: https://www.awsarchitectureblog.com/2015/03/backoff.html -

Parameters:
  • options (Hash) --

Overloads:
  • initialize(options)
def initialize(*args)
  super
end

def initiate_layer_upload(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • initiate_layer_upload(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/InitiateLayerUpload - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::InitiateLayerUploadResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :repository_name (required, String) --
  • :registry_id (String) --
def initiate_layer_upload(params = {}, options = {})
  req = build_request(:initiate_layer_upload, params)
  req.send_request(options)
end

def list_images(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_images(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/ListImages - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -
    Example: Example: To list all images in a repository -

Returns:
  • (Types::ListImagesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :filter (Types::ListImagesFilter) --
  • :max_results (Integer) --
  • :next_token (String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def list_images(params = {}, options = {})
  req = build_request(:list_images, params)
  req.send_request(options)
end

def list_tags_for_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_tags_for_resource(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/ListTagsForResource - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListTagsForResourceResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :resource_arn (required, String) --
def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

def put_image(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_image(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutImage - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutImageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :image_digest (String) --
  • :image_tag (String) --
  • :image_manifest_media_type (String) --
  • :image_manifest (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def put_image(params = {}, options = {})
  req = build_request(:put_image, params)
  req.send_request(options)
end

def put_image_scanning_configuration(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_image_scanning_configuration(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutImageScanningConfiguration - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutImageScanningConfigurationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :image_scanning_configuration (required, Types::ImageScanningConfiguration) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def put_image_scanning_configuration(params = {}, options = {})
  req = build_request(:put_image_scanning_configuration, params)
  req.send_request(options)
end

def put_image_tag_mutability(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_image_tag_mutability(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutImageTagMutability - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutImageTagMutabilityResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :image_tag_mutability (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def put_image_tag_mutability(params = {}, options = {})
  req = build_request(:put_image_tag_mutability, params)
  req.send_request(options)
end

def put_lifecycle_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_lifecycle_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutLifecyclePolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutLifecyclePolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :lifecycle_policy_text (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def put_lifecycle_policy(params = {}, options = {})
  req = build_request(:put_lifecycle_policy, params)
  req.send_request(options)
end

def put_registry_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_registry_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutRegistryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutRegistryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :policy_text (required, String) --
def put_registry_policy(params = {}, options = {})
  req = build_request(:put_registry_policy, params)
  req.send_request(options)
end

def put_registry_scanning_configuration(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_registry_scanning_configuration(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutRegistryScanningConfiguration - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutRegistryScanningConfigurationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :rules (Array) --
  • :scan_type (String) --
def put_registry_scanning_configuration(params = {}, options = {})
  req = build_request(:put_registry_scanning_configuration, params)
  req.send_request(options)
end

def put_replication_configuration(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • put_replication_configuration(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/PutReplicationConfiguration - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PutReplicationConfigurationResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :replication_configuration (required, Types::ReplicationConfiguration) --
def put_replication_configuration(params = {}, options = {})
  req = build_request(:put_replication_configuration, params)
  req.send_request(options)
end

def set_repository_policy(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • set_repository_policy(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/SetRepositoryPolicy - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::SetRepositoryPolicyResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :force (Boolean) --
  • :policy_text (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def set_repository_policy(params = {}, options = {})
  req = build_request(:set_repository_policy, params)
  req.send_request(options)
end

def start_image_scan(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • start_image_scan(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartImageScan - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::StartImageScanResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :image_id (required, Types::ImageIdentifier) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def start_image_scan(params = {}, options = {})
  req = build_request(:start_image_scan, params)
  req.send_request(options)
end

def start_lifecycle_policy_preview(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • start_lifecycle_policy_preview(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/StartLifecyclePolicyPreview - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::StartLifecyclePolicyPreviewResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :lifecycle_policy_text (String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def start_lifecycle_policy_preview(params = {}, options = {})
  req = build_request(:start_lifecycle_policy_preview, params)
  req.send_request(options)
end

def tag_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • tag_resource(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/TagResource - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tags (required, Array) --
  • :resource_arn (required, String) --
def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

def untag_resource(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • untag_resource(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/UntagResource - AWS API Documentation

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tag_keys (required, Array) --
  • :resource_arn (required, String) --
def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

def upload_layer_part(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • upload_layer_part(params = {})

Other tags:
    See: http://docs.aws.amazon.com/goto/WebAPI/ecr-2015-09-21/UploadLayerPart - AWS API Documentation

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::UploadLayerPartResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :layer_part_blob (required, String, StringIO, File) --
  • :part_last_byte (required, Integer) --
  • :part_first_byte (required, Integer) --
  • :upload_id (required, String) --
  • :repository_name (required, String) --
  • :registry_id (String) --
def upload_layer_part(params = {}, options = {})
  req = build_request(:upload_layer_part, params)
  req.send_request(options)
end

def wait_until(waiter_name, params = {}, options = {})

Options Hash: (**options)
  • :before_wait (Proc) --
  • :before_attempt (Proc) --
  • :delay (Integer) --
  • :max_attempts (Integer) --

Parameters:
  • options (Hash) -- ({})
  • params (Hash) -- ({})
  • waiter_name (Symbol) --

Returns:
  • (Boolean) - Returns `true` if the waiter was successful.

Raises:
  • (Errors::NoSuchWaiterError) - Raised when you request to wait
  • (Errors::UnexpectedError) - Raised when an error is encounted
  • (Errors::TooManyAttemptsError) - Raised when the configured
  • (Errors::FailureStateError) - Raised when the waiter terminates
def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end

def waiter(waiter_name, options = {})

Parameters:
  • options (Hash) -- ({})
  • waiter_name (Symbol) --
def waiter(waiter_name, options = {})
  waiter_class = waiters[waiter_name]
  if waiter_class
    waiter_class.new(options.merge(client: self))
  else
    raise Aws::Waiters::Errors::NoSuchWaiterError.new(waiter_name, waiters.keys)
  end
end

def waiter_names

Deprecated:

Other tags:
    Api: - private
def waiter_names
  waiters.keys
end

def waiters

def waiters
  {
    image_scan_complete: Waiters::ImageScanComplete,
    lifecycle_policy_preview_complete: Waiters::LifecyclePolicyPreviewComplete
  }
end