describe_repositories
async
¶
describe_repositories(
*,
config_overrides: Optional[AsyncECRPUBLICClientConfig] = None,
registry_id: Optional[RegistryId] = None,
repository_names: Optional[RepositoryNameList] = None,
next_token: Optional[NextToken] = None,
max_results: Optional[MaxResults] = None,
) -> DescribeRepositoriesResponse
Describes repositories that are in a public registry.
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_names(Optional[RepositoryNameList], default:None) –A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.
-
next_token(Optional[NextToken], default:None) –The
nextTokenvalue that's returned from a previous paginatedDescribeRepositoriesrequest wheremaxResultswas used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextTokenvalue. If there are no more results to return, this value isnull. If you specify repositories withrepositoryNames, you can't use this option.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
-
max_results(Optional[MaxResults], default:None) –The maximum number of repository results that's returned by
DescribeRepositoriesin paginated output. When this parameter is used,DescribeRepositoriesonly returnsmaxResultsresults in a single page along with anextTokenresponse element. You can see the remaining results of the initial request by sending anotherDescribeRepositoriesrequest with the returnednextTokenvalue. This value can be between 1 and 1000. If this parameter isn't used, thenDescribeRepositoriesreturns up to 100 results and anextTokenvalue, if applicable. If you specify repositories withrepositoryNames, you can't use this option.
Raises:
-
InvalidParameterException–The specified parameter is invalid. Review the available parameters for the API request.
-
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.
-
ServerException–These errors are usually caused by a server-side issue.
-
UnsupportedCommandException–The action isn't supported in this Region.
-
UnknownServiceError–The service returned an error code this client does not model.