Returns a list of direct children of the specified package group.
For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
Parameters:
-
domain
(DomainName)
–
The name of the domain which contains the package group from which to list sub 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.
-
package_group
(PackageGroupPattern)
–
The pattern of the package group from which to list sub package groups.
-
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.
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/codeartifact.py
| def list_sub_package_groups(
self,
domain: "capo_codeartifact.types.domain_name.DomainName",
package_group: "capo_codeartifact.types.package_group_pattern.PackageGroupPattern",
*,
config_overrides: Optional[codeartifactClientConfig] = 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,
) -> "capo_codeartifact.types.list_sub_package_groups_result.ListSubPackageGroupsResult":
"""<p>Returns a list of direct children of the specified package group.</p> <p>For information package group hierarchy, see <a href="https://docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html">Package group definition syntax and matching behavior</a> in the <i>CodeArtifact User Guide</i>.</p>
Args:
domain: <p> The name of the domain which contains the package group from which to list sub 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>
package_group: <p> The pattern of the package group from which to list sub package groups. </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>
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.
"""
def _handler(
req: "OperationRequest[capo_codeartifact.types.list_sub_package_groups_request.ListSubPackageGroupsRequest]",
) -> OperationResponse[
"capo_codeartifact.types.list_sub_package_groups_result.ListSubPackageGroupsResult"
]:
import capo_codeartifact._operations.code_artifact_control_plane_service.list_sub_package_groups
output, http_response = (
capo_codeartifact._operations.code_artifact_control_plane_service.list_sub_package_groups.list_sub_package_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListSubPackageGroups")
)
input_: capo_codeartifact.types.list_sub_package_groups_request.ListSubPackageGroupsRequest = {
"domain": domain,
"package_group": package_group,
}
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
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|