associate_resource ¶

def associate_resource(
    self,
    group_identifier: "capo_synthetics.types.group_identifier.GroupIdentifier",
    resource_arn: "capo_synthetics.types.canary_arn.CanaryArn",
    *,
    config_overrides: Optional[syntheticsClientConfig] = None,
) -> "capo_synthetics.types.associate_resource_response.AssociateResourceResponse":
    """<p>Associates a canary with a group. Using groups can help you with managing and automating your canaries, and you can also view aggregated run results and statistics for all canaries in a group. </p> <p>You must run this operation in the Region where the canary exists.</p>

    Args:
        group_identifier: <p>Specifies the group. You can specify the group name, the ARN, or the group ID as the <code>GroupIdentifier</code>.</p>
        resource_arn: <p>The ARN of the canary that you want to associate with the specified group.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeded a service quota value.</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.associate_resource_request.AssociateResourceRequest]",
    ) -> OperationResponse[
        "capo_synthetics.types.associate_resource_response.AssociateResourceResponse"
    ]:
        import capo_synthetics._operations.synthetics.associate_resource

        output, http_response = (
            capo_synthetics._operations.synthetics.associate_resource.associate_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateResource")
    )
    input_: capo_synthetics.types.associate_resource_request.AssociateResourceRequest = {
        "group_identifier": group_identifier,
        "resource_arn": resource_arn,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output