Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.
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 groups are returned each time you use the ListAssociatedGroups operation. If you omit this parameter, the default of 20 is used.
-
resource_arn
(CanaryArn)
–
The ARN of the canary that you want to view groups for.
Raises:
Source code in docs_src/capo_synthetics/_services/synthetics.py
| def list_associated_groups(
self,
resource_arn: "capo_synthetics.types.canary_arn.CanaryArn",
*,
config_overrides: Optional[syntheticsClientConfig] = 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_associated_groups_response.ListAssociatedGroupsResponse":
"""<p>Returns a list of the groups that the specified canary is associated with. The canary that you specify must be in the current Region.</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 groups are returned each time you use the <code>ListAssociatedGroups</code> operation. If you omit this parameter, the default of 20 is used.</p>
resource_arn: <p>The ARN of the canary that you want to view groups for.</p>
Raises:
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.
"""
def _handler(
req: "OperationRequest[capo_synthetics.types.list_associated_groups_request.ListAssociatedGroupsRequest]",
) -> OperationResponse[
"capo_synthetics.types.list_associated_groups_response.ListAssociatedGroupsResponse"
]:
import capo_synthetics._operations.synthetics.list_associated_groups
output, http_response = (
capo_synthetics._operations.synthetics.list_associated_groups.list_associated_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListAssociatedGroups")
)
input_: capo_synthetics.types.list_associated_groups_request.ListAssociatedGroupsRequest = {
"resource_arn": resource_arn
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|