list_package_groups `async` ¶

list_package_groups(
    domain: DomainName,
    *,
    config_overrides: Optional[AsynccodeartifactClientConfig] = None,
    domain_owner: Optional[AccountId] = None,
    max_results: Optional[ListPackageGroupsMaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    prefix: Optional[PackageGroupPatternPrefix] = None,
) -> ListPackageGroupsResult

Returns a list of package groups in the requested domain.

Parameters:

domain (DomainName) –

The domain for which you want to list package groups.
domain_owner (Optional[AccountId], default: None ) –

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
max_results (Optional[ListPackageGroupsMaxResults], default: None ) –

The maximum number of results to return per page.
next_token (Optional[PaginationToken], default: None ) –

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
prefix (Optional[PackageGroupPatternPrefix], default: None ) –

A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.

Raises:

AccessDeniedException –

The operation did not succeed because of an unauthorized access attempt.
InternalServerException –

The operation did not succeed because of an error that occurred inside CodeArtifact.
ResourceNotFoundException –

The operation did not succeed because the resource requested is not found in the service.
ThrottlingException –

The operation did not succeed because too many requests are sent to the service.
ValidationException –

The operation did not succeed because a parameter in the request was sent with an invalid value.
UnknownServiceError –

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

Source code in docs_src/capo_codeartifact/_services/async_codeartifact.py

async def list_package_groups(
    self,
    domain: "capo_codeartifact.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsynccodeartifactClientConfig] = None,
    domain_owner: Optional["capo_codeartifact.types.account_id.AccountId"] = None,
    max_results: Optional[
        "capo_codeartifact.types.list_package_groups_max_results.ListPackageGroupsMaxResults"
    ] = None,
    next_token: Optional[
        "capo_codeartifact.types.pagination_token.PaginationToken"
    ] = None,
    prefix: Optional[
        "capo_codeartifact.types.package_group_pattern_prefix.PackageGroupPatternPrefix"
    ] = None,
) -> "capo_codeartifact.types.list_package_groups_result.ListPackageGroupsResult":
    """<p>Returns a list of package groups in the requested domain.</p>

    Args:
        domain: <p> The domain for which you want to list package groups. </p>
        domain_owner: <p> The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. </p>
        max_results: <p> The maximum number of results to return per page. </p>
        next_token: <p> The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. </p>
        prefix: <p> A prefix for which to search package groups. When included, <code>ListPackageGroups</code> will return only package groups with patterns that match the prefix. </p>

    Raises:
        capo_codeartifact.errors.access_denied_exception.AccessDeniedException: <p> The operation did not succeed because of an unauthorized access attempt. </p>
        capo_codeartifact.errors.internal_server_exception.InternalServerException: <p> The operation did not succeed because of an error that occurred inside CodeArtifact. </p>
        capo_codeartifact.errors.resource_not_found_exception.ResourceNotFoundException: <p> The operation did not succeed because the resource requested is not found in the service. </p>
        capo_codeartifact.errors.throttling_exception.ThrottlingException: <p> The operation did not succeed because too many requests are sent to the service. </p>
        capo_codeartifact.errors.validation_exception.ValidationException: <p> The operation did not succeed because a parameter in the request was sent with an invalid value. </p>
        capo_codeartifact.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codeartifact.types.list_package_groups_request.ListPackageGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_codeartifact.types.list_package_groups_result.ListPackageGroupsResult"
    ]:
        import capo_codeartifact._operations.code_artifact_control_plane_service.list_package_groups

        (
            output,
            http_response,
        ) = await capo_codeartifact._operations.code_artifact_control_plane_service.list_package_groups.async_list_package_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPackageGroups")
    )
    input_: capo_codeartifact.types.list_package_groups_request.ListPackageGroupsRequest = {
        "domain": domain
    }
    if domain_owner is not None:
        input_["domain_owner"] = domain_owner
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if prefix is not None:
        input_["prefix"] = prefix

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_package_groups async ¶

list_package_groups `async` ¶