Skip to content

create_package

create_package(
    package_name: PackageName,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    description: Optional[ResourceDescription] = None,
    tags: Optional[TagMap] = None,
    client_token: Optional[ClientToken] = None,
) -> CreatePackageResponse

Creates an IoT software package that can be deployed to your fleet.

Requires permission to access the CreatePackage and GetIndexingConfiguration actions.

Parameters:

  • package_name (PackageName) –

    The name of the new software package.

  • description (Optional[ResourceDescription], default: None ) –

    A summary of the package being created. This can be used to outline the package's contents or purpose.

  • tags (Optional[TagMap], default: None ) –

    Metadata that can be used to manage the package.

  • client_token (Optional[ClientToken], default: None ) –

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def create_package(
    self,
    package_name: "capo_iot.types.package_name.PackageName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    description: Optional[
        "capo_iot.types.resource_description.ResourceDescription"
    ] = None,
    tags: Optional["capo_iot.types.tag_map.TagMap"] = None,
    client_token: Optional["capo_iot.types.client_token.ClientToken"] = None,
) -> "capo_iot.types.create_package_response.CreatePackageResponse":
    """<p>Creates an IoT software package that can be deployed to your fleet.</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">CreatePackage</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetIndexingConfiguration</a> actions.</p>

    Args:
        package_name: <p>The name of the new software package.</p>
        description: <p>A summary of the package being created. This can be used to outline the package's contents or purpose.</p>
        tags: <p>Metadata that can be used to manage the package.</p>
        client_token: <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>

    Raises:
        capo_iot.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource.</p>
        capo_iot.errors.internal_server_exception.InternalServerException: <p>Internal error from the service that indicates an unexpected error or that the service is unavailable.</p>
        capo_iot.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Service quota has been exceeded.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.validation_exception.ValidationException: <p>The request is not valid.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.create_package_request.CreatePackageRequest]",
    ) -> OperationResponse[
        "capo_iot.types.create_package_response.CreatePackageResponse"
    ]:
        import capo_iot._operations.aws_iot_service.create_package

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

    def _redact_input(
        input_: "capo_iot.types.create_package_request.CreatePackageRequest",
    ) -> dict[str, Any]:
        import capo_iot.types.create_package_request

        return capo_iot.types.create_package_request.redact_sensitive(input_)

    def _redact_output(
        output: "capo_iot.types.create_package_response.CreatePackageResponse",
    ) -> dict[str, Any]:
        import capo_iot.types.create_package_response

        return capo_iot.types.create_package_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreatePackage",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_iot.types.create_package_request.CreatePackageRequest = {
        "package_name": package_name
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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