Skip to content

start_associations_once

start_associations_once(
    association_ids: AssociationIdList,
    *,
    config_overrides: Optional[SSMClientConfig] = None,
) -> StartAssociationsOnceResult

Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.

Parameters:

  • association_ids (AssociationIdList) –

    The association IDs that you want to run immediately and only one time.

Raises:

Source code in docs_src/capo_ssm/_services/ssm.py
def start_associations_once(
    self,
    association_ids: "capo_ssm.types.association_id_list.AssociationIdList",
    *,
    config_overrides: Optional[SSMClientConfig] = None,
) -> "capo_ssm.types.start_associations_once_result.StartAssociationsOnceResult":
    """<p>Runs an association immediately and only one time. This operation can be helpful when troubleshooting associations.</p>

    Args:
        association_ids: <p>The association IDs that you want to run immediately and only one time.</p>

    Raises:
        capo_ssm.errors.association_does_not_exist.AssociationDoesNotExist: <p>The specified association doesn't exist.</p>
        capo_ssm.errors.invalid_association.InvalidAssociation: <p>The association isn't valid or doesn't exist. </p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm.types.start_associations_once_request.StartAssociationsOnceRequest]",
    ) -> OperationResponse[
        "capo_ssm.types.start_associations_once_result.StartAssociationsOnceResult"
    ]:
        import capo_ssm._operations.amazon_ssm.start_associations_once

        output, http_response = (
            capo_ssm._operations.amazon_ssm.start_associations_once.start_associations_once(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartAssociationsOnce")
    )
    input_: capo_ssm.types.start_associations_once_request.StartAssociationsOnceRequest = {
        "association_ids": association_ids
    }

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