Skip to content

describe_image_replication_status

describe_image_replication_status(
    repository_name: RepositoryName,
    image_id: ImageIdentifier,
    *,
    config_overrides: Optional[ECRClientConfig] = None,
    registry_id: Optional[RegistryId] = None,
) -> DescribeImageReplicationStatusResponse

Returns the replication status for a specified image.

Parameters:

  • repository_name (RepositoryName) –

    The name of the repository that the image is in.

  • registry_id (Optional[RegistryId], default: None ) –

    The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.

Raises:

  • ImageNotFoundException –

    The image requested does not exist in the specified repository.

  • InvalidParameterException –

    The specified parameter is invalid. Review the available parameters for the API request.

  • RepositoryNotFoundException –

    The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

  • ServerException –

    These errors are usually caused by a server-side issue.

  • ValidationException –

    There was an exception validating this request.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_ecr/_services/ecr.py
def describe_image_replication_status(
    self,
    repository_name: "capo_ecr.types.repository_name.RepositoryName",
    image_id: "capo_ecr.types.image_identifier.ImageIdentifier",
    *,
    config_overrides: Optional[ECRClientConfig] = None,
    registry_id: Optional["capo_ecr.types.registry_id.RegistryId"] = None,
) -> "capo_ecr.types.describe_image_replication_status_response.DescribeImageReplicationStatusResponse":
    """<p>Returns the replication status for a specified image.</p>

    Args:
        repository_name: <p>The name of the repository that the image is in.</p>
        registry_id: <p>The Amazon Web Services account ID associated with the registry. If you do not specify a registry, the default registry is assumed.</p>

    Raises:
        capo_ecr.errors.image_not_found_exception.ImageNotFoundException: <p>The image requested does not exist in the specified repository.</p>
        capo_ecr.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_ecr.errors.repository_not_found_exception.RepositoryNotFoundException: <p>The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.</p>
        capo_ecr.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_ecr.errors.validation_exception.ValidationException: <p>There was an exception validating this request.</p>
        capo_ecr.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ecr.types.describe_image_replication_status_request.DescribeImageReplicationStatusRequest]",
    ) -> OperationResponse[
        "capo_ecr.types.describe_image_replication_status_response.DescribeImageReplicationStatusResponse"
    ]:
        import capo_ecr._operations.amazon_ec2_container_registry_v20150921.describe_image_replication_status

        output, http_response = (
            capo_ecr._operations.amazon_ec2_container_registry_v20150921.describe_image_replication_status.describe_image_replication_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeImageReplicationStatus")
    )
    input_: capo_ecr.types.describe_image_replication_status_request.DescribeImageReplicationStatusRequest = {
        "repository_name": repository_name,
        "image_id": image_id,
    }
    if registry_id is not None:
        input_["registry_id"] = registry_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output