Skip to content

get_service_sync_blocker_summary

get_service_sync_blocker_summary(
    service_name: ResourceName,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    service_instance_name: Optional[ResourceName] = None,
) -> GetServiceSyncBlockerSummaryOutput

Get detailed data for the service sync blocker summary.

Parameters:

  • service_name (ResourceName) –

    The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.

  • service_instance_name (Optional[ResourceName], default: None ) –

    The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.

Raises:

Source code in docs_src/capo_proton/_services/proton.py
def get_service_sync_blocker_summary(
    self,
    service_name: "capo_proton.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    service_instance_name: Optional[
        "capo_proton.types.resource_name.ResourceName"
    ] = None,
) -> "capo_proton.types.get_service_sync_blocker_summary_output.GetServiceSyncBlockerSummaryOutput":
    """<p>Get detailed data for the service sync blocker summary.</p>

    Args:
        service_name: <p>The name of the service that you want to get the service sync blocker summary for. If given only the service name, all instances are blocked.</p>
        service_instance_name: <p>The name of the service instance that you want to get the service sync blocker summary for. If given bothe the instance name and the service name, only the instance is blocked.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.get_service_sync_blocker_summary_input.GetServiceSyncBlockerSummaryInput]",
    ) -> OperationResponse[
        "capo_proton.types.get_service_sync_blocker_summary_output.GetServiceSyncBlockerSummaryOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.get_service_sync_blocker_summary

        output, http_response = (
            capo_proton._operations.aws_proton20200720.get_service_sync_blocker_summary.get_service_sync_blocker_summary(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetServiceSyncBlockerSummary")
    )
    input_: capo_proton.types.get_service_sync_blocker_summary_input.GetServiceSyncBlockerSummaryInput = {
        "service_name": service_name
    }
    if service_instance_name is not None:
        input_["service_instance_name"] = service_instance_name

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