update_package ¶

def update_package(
    self,
    package_name: "capo_iot.types.package_name.PackageName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
    description: Optional[
        "capo_iot.types.resource_description.ResourceDescription"
    ] = None,
    default_version_name: Optional[
        "capo_iot.types.version_name.VersionName"
    ] = None,
    unset_default_version: Optional[
        "capo_iot.types.unset_default_version.UnsetDefaultVersion"
    ] = None,
    client_token: Optional["capo_iot.types.client_token.ClientToken"] = None,
) -> "capo_iot.types.update_package_response.UpdatePackageResponse":
    """<p>Updates the supported fields for a specific software package.</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">UpdatePackage</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 target software package.</p>
        description: <p>The package description.</p>
        default_version_name: <p>The name of the default package version.</p> <p> <b>Note:</b> You cannot name a <code>defaultVersion</code> and set <code>unsetDefaultVersion</code> equal to <code>true</code> at the same time.</p>
        unset_default_version: <p>Indicates whether you want to remove the named default package version from the software package. Set as <code>true</code> to remove the default package version. </p> <p> <b>Note:</b> You cannot name a <code>defaultVersion</code> and set <code>unsetDefaultVersion</code> equal to <code>true</code> at the same time.</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.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.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.update_package_request.UpdatePackageRequest]",
    ) -> OperationResponse[
        "capo_iot.types.update_package_response.UpdatePackageResponse"
    ]:
        import capo_iot._operations.aws_iot_service.update_package

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

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

        return capo_iot.types.update_package_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdatePackage", redact_input=_redact_input),
    )
    input_: capo_iot.types.update_package_request.UpdatePackageRequest = {
        "package_name": package_name
    }
    if description is not None:
        input_["description"] = description
    if default_version_name is not None:
        input_["default_version_name"] = default_version_name
    if unset_default_version is not None:
        input_["unset_default_version"] = unset_default_version
    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