Skip to content

start_instance_onboarding_job

start_instance_onboarding_job(
    connect_instance_id: InstanceId,
    encryption_config: EncryptionConfig,
    *,
    config_overrides: Optional[ConnectCampaignsClientConfig] = None,
) -> StartInstanceOnboardingJobResponse

Onboard the specific Amazon Connect instance to Connect Campaigns.

Raises:

Source code in docs_src/capo_connectcampaigns/_services/connect_campaigns.py
def start_instance_onboarding_job(
    self,
    connect_instance_id: "capo_connectcampaigns.types.instance_id.InstanceId",
    encryption_config: "capo_connectcampaigns.types.encryption_config.EncryptionConfig",
    *,
    config_overrides: Optional[ConnectCampaignsClientConfig] = None,
) -> "capo_connectcampaigns.types.start_instance_onboarding_job_response.StartInstanceOnboardingJobResponse":
    """Onboard the specific Amazon Connect instance to Connect Campaigns.

    Raises:
        capo_connectcampaigns.errors.access_denied_exception.AccessDeniedException: You do not have sufficient access to perform this action.
        capo_connectcampaigns.errors.conflict_exception.ConflictException: The request could not be processed because of conflict in the current state of the resource.
        capo_connectcampaigns.errors.internal_server_exception.InternalServerException: Request processing failed because of an error or failure with the service.
        capo_connectcampaigns.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource was not found.
        capo_connectcampaigns.errors.throttling_exception.ThrottlingException: The request was denied due to request throttling.
        capo_connectcampaigns.errors.validation_exception.ValidationException: The input fails to satisfy the constraints specified by an AWS service.
        capo_connectcampaigns.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connectcampaigns.types.start_instance_onboarding_job_request.StartInstanceOnboardingJobRequest]",
    ) -> OperationResponse[
        "capo_connectcampaigns.types.start_instance_onboarding_job_response.StartInstanceOnboardingJobResponse"
    ]:
        import capo_connectcampaigns._operations.amazon_connect_campaign_service.start_instance_onboarding_job

        output, http_response = (
            capo_connectcampaigns._operations.amazon_connect_campaign_service.start_instance_onboarding_job.start_instance_onboarding_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartInstanceOnboardingJob")
    )
    input_: capo_connectcampaigns.types.start_instance_onboarding_job_request.StartInstanceOnboardingJobRequest = {
        "connect_instance_id": connect_instance_id,
        "encryption_config": encryption_config,
    }

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