Skip to content

get_repository_policy

get_repository_policy(
    repository_name: RepositoryName,
    *,
    config_overrides: Optional[ECRClientConfig] = None,
    registry_id: Optional[RegistryId] = None,
) -> GetRepositoryPolicyResponse

Retrieves the repository policy for the specified repository.

Parameters:

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

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

  • repository_name (RepositoryName) –

    The name of the repository with the policy to retrieve.

Raises:

  • 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.

  • RepositoryPolicyNotFoundException –

    The specified repository and registry combination does not have an associated repository policy.

  • ServerException –

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

  • UnknownServiceError –

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

Examples:

To get the current policy for a repository This example obtains the repository policy for the repository named ubuntu.

>>> client.get_repository_policy(repository_name='ubuntu')
Source code in docs_src/capo_ecr/_services/ecr.py
def get_repository_policy(
    self,
    repository_name: "capo_ecr.types.repository_name.RepositoryName",
    *,
    config_overrides: Optional[ECRClientConfig] = None,
    registry_id: Optional["capo_ecr.types.registry_id.RegistryId"] = None,
) -> "capo_ecr.types.get_repository_policy_response.GetRepositoryPolicyResponse":
    """<p>Retrieves the repository policy for the specified repository.</p>

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

    Raises:
        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.repository_policy_not_found_exception.RepositoryPolicyNotFoundException: <p>The specified repository and registry combination does not have an associated repository policy.</p>
        capo_ecr.errors.server_exception.ServerException: <p>These errors are usually caused by a server-side issue.</p>
        capo_ecr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get the current policy for a repository
        This example obtains the repository policy for the repository named ubuntu.

        >>> client.get_repository_policy(repository_name='ubuntu')
    """

    def _handler(
        req: "OperationRequest[capo_ecr.types.get_repository_policy_request.GetRepositoryPolicyRequest]",
    ) -> OperationResponse[
        "capo_ecr.types.get_repository_policy_response.GetRepositoryPolicyResponse"
    ]:
        import capo_ecr._operations.amazon_ec2_container_registry_v20150921.get_repository_policy

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRepositoryPolicy")
    )
    input_: capo_ecr.types.get_repository_policy_request.GetRepositoryPolicyRequest = {
        "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