Skip to content

get_repository_catalog_data 

get_repository_catalog_data(
    repository_name: RepositoryName,
    *,
    config_overrides: Optional[ECRPUBLICClientConfig] = None,
    registry_id: Optional[RegistryId] = None,
) -> GetRepositoryCatalogDataResponse

Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.

Parameters:

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

    The Amazon Web Services account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.

  • repository_name (RepositoryName) –

    The name of the repository to retrieve the catalog metadata for.

Raises:

Source code in docs_src/capo_ecr_public/_services/ecrpublic.py 
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
def get_repository_catalog_data(
    self,
    repository_name: "capo_ecr_public.types.repository_name.RepositoryName",
    *,
    config_overrides: Optional[ECRPUBLICClientConfig] = None,
    registry_id: Optional["capo_ecr_public.types.registry_id.RegistryId"] = None,
) -> "capo_ecr_public.types.get_repository_catalog_data_response.GetRepositoryCatalogDataResponse":
    """<p>Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.</p>

    Args:
        registry_id: <p>The Amazon Web Services account ID that's associated with the registry that contains the repositories to be described. If you do not specify a registry, the default public registry is assumed.</p>
        repository_name: <p>The name of the repository to retrieve the catalog metadata for.</p>

    Raises:
        capo_ecr_public.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter is invalid. Review the available parameters for the API request.</p>
        capo_ecr_public.errors.repository_catalog_data_not_found_exception.RepositoryCatalogDataNotFoundException: <p>The repository catalog data doesn't exist.</p>
        capo_ecr_public.errors.repository_not_found_exception.RepositoryNotFoundException: <p>The specified repository can't be found. Check the spelling of the specified repository and ensure that you're performing operations on the correct registry.</p>
        capo_ecr_public.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_ecr_public.errors.unsupported_command_exception.UnsupportedCommandException: <p>The action isn't supported in this Region.</p>
        capo_ecr_public.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ecr_public.types.get_repository_catalog_data_request.GetRepositoryCatalogDataRequest]",
    ) -> OperationResponse[
        "capo_ecr_public.types.get_repository_catalog_data_response.GetRepositoryCatalogDataResponse"
    ]:
        import capo_ecr_public._operations.spencer_frontend_service.get_repository_catalog_data

        output, http_response = (
            capo_ecr_public._operations.spencer_frontend_service.get_repository_catalog_data.get_repository_catalog_data(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRepositoryCatalogData")
    )
    input_: capo_ecr_public.types.get_repository_catalog_data_request.GetRepositoryCatalogDataRequest = {
        "repository_name": repository_name
    }
    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