GetRepositoryPolicy - Amazon Elastic Container Registry Public

GetRepositoryPolicy

Retrieves the repository policy for the specified repository.

Request Syntax

{ "registryId": "string", "repositoryName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

registryId

The AWS account ID that's associated with the public registry that contains the repository. If you do not specify a registry, the default public registry is assumed.

Type: String

Pattern: [0-9]{12}

Required: No

repositoryName

The name of the repository with the policy to retrieve.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 205.

Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

Required: Yes

Response Syntax

{ "policyText": "string", "registryId": "string", "repositoryName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

policyText

The repository policy text that's associated with the repository. The policy text will be in JSON format.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 10240.

registryId

The registry ID that's associated with the request.

Type: String

Pattern: [0-9]{12}

repositoryName

The repository name that's associated with the request.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 205.

Pattern: (?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

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

HTTP Status Code: 400

RepositoryNotFoundException

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.

HTTP Status Code: 400

RepositoryPolicyNotFoundException

The specified repository and registry combination doesn't have an associated repository policy.

HTTP Status Code: 400

ServerException

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

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: