Skip to content

list_group_resources async

list_group_resources(
    group_identifier: GroupIdentifier,
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxGroupResults] = None,
) -> ListGroupResourcesResponse

This operation returns a list of the ARNs of the canaries that are associated with the specified group.

Parameters:

  • next_token (Optional[PaginationToken], default: None ) –

    A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.

  • max_results (Optional[MaxGroupResults], default: None ) –

    Specify this parameter to limit how many canary ARNs are returned each time you use the ListGroupResources operation. If you omit this parameter, the default of 20 is used.

  • group_identifier (GroupIdentifier) –

    Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Raises:

Source code in docs_src/capo_synthetics/_services/async_synthetics.py
async def list_group_resources(
    self,
    group_identifier: "capo_synthetics.types.group_identifier.GroupIdentifier",
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
    next_token: Optional[
        "capo_synthetics.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_synthetics.types.max_group_results.MaxGroupResults"
    ] = None,
) -> (
    "capo_synthetics.types.list_group_resources_response.ListGroupResourcesResponse"
):
    """<p>This operation returns a list of the ARNs of the canaries that are associated with the specified group.</p>

    Args:
        next_token: <p>A token that indicates that there is more data available. You can use this token in a subsequent operation to retrieve the next set of results.</p>
        max_results: <p>Specify this parameter to limit how many canary ARNs are returned each time you use the <code>ListGroupResources</code> operation. If you omit this parameter, the default of 20 is used.</p>
        group_identifier: <p>Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the <code>GroupIdentifier</code>.</p>

    Raises:
        capo_synthetics.errors.conflict_exception.ConflictException: <p>A conflicting operation is already in progress.</p>
        capo_synthetics.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred.</p>
        capo_synthetics.errors.resource_not_found_exception.ResourceNotFoundException: <p>One of the specified resources was not found.</p>
        capo_synthetics.errors.validation_exception.ValidationException: <p>A parameter could not be validated.</p>
        capo_synthetics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_synthetics.types.list_group_resources_request.ListGroupResourcesRequest]",
    ) -> AsyncOperationResponse[
        "capo_synthetics.types.list_group_resources_response.ListGroupResourcesResponse"
    ]:
        import capo_synthetics._operations.synthetics.list_group_resources

        (
            output,
            http_response,
        ) = await capo_synthetics._operations.synthetics.list_group_resources.async_list_group_resources(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGroupResources")
    )
    input_: capo_synthetics.types.list_group_resources_request.ListGroupResourcesRequest = {
        "group_identifier": group_identifier
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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