Skip to content

create_provisioning_template_version

create_provisioning_template_version(
    template_name: TemplateName,
    template_body: TemplateBody,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    set_as_default: Optional[SetAsDefault] = None,
) -> CreateProvisioningTemplateVersionResponse

Creates a new version of a provisioning template.

Requires permission to access the CreateProvisioningTemplateVersion action.

Parameters:

  • template_name (TemplateName) –

    The name of the provisioning template.

  • template_body (TemplateBody) –

    The JSON formatted contents of the provisioning template.

  • set_as_default (Optional[SetAsDefault], default: None ) –

    Sets a fleet provision template version as the default version.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def create_provisioning_template_version(
    self,
    template_name: "capo_iot.types.template_name.TemplateName",
    template_body: "capo_iot.types.template_body.TemplateBody",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    set_as_default: Optional["capo_iot.types.set_as_default.SetAsDefault"] = None,
) -> "capo_iot.types.create_provisioning_template_version_response.CreateProvisioningTemplateVersionResponse":
    """<p>Creates a new version of a provisioning template.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateProvisioningTemplateVersion</a> action.</p>

    Args:
        template_name: <p>The name of the provisioning template.</p>
        template_body: <p>The JSON formatted contents of the provisioning template.</p>
        set_as_default: <p>Sets a fleet provision template version as the default version.</p>

    Raises:
        capo_iot.errors.conflicting_resource_update_exception.ConflictingResourceUpdateException: <p>A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.</p>
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.versions_limit_exceeded_exception.VersionsLimitExceededException: <p>The number of policy versions exceeds the limit.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.create_provisioning_template_version_request.CreateProvisioningTemplateVersionRequest]",
    ) -> OperationResponse[
        "capo_iot.types.create_provisioning_template_version_response.CreateProvisioningTemplateVersionResponse"
    ]:
        import capo_iot._operations.aws_iot_service.create_provisioning_template_version

        output, http_response = (
            capo_iot._operations.aws_iot_service.create_provisioning_template_version.create_provisioning_template_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateProvisioningTemplateVersion")
    )
    input_: capo_iot.types.create_provisioning_template_version_request.CreateProvisioningTemplateVersionRequest = {
        "template_name": template_name,
        "template_body": template_body,
    }
    if set_as_default is not None:
        input_["set_as_default"] = set_as_default

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