create_patch_baseline async ¶

async def create_patch_baseline(
    self,
    name: "capo_ssm.types.baseline_name.BaselineName",
    *,
    config_overrides: Optional[AsyncSSMClientConfig] = None,
    operating_system: Optional[
        "capo_ssm.types.operating_system.OperatingSystem"
    ] = None,
    global_filters: Optional[
        "capo_ssm.types.patch_filter_group.PatchFilterGroup"
    ] = None,
    approval_rules: Optional[
        "capo_ssm.types.patch_rule_group.PatchRuleGroup"
    ] = None,
    approved_patches: Optional["capo_ssm.types.patch_id_list.PatchIdList"] = None,
    approved_patches_compliance_level: Optional[
        "capo_ssm.types.patch_compliance_level.PatchComplianceLevel"
    ] = None,
    approved_patches_enable_non_security: Optional[
        "capo_ssm.types.boolean.Boolean"
    ] = None,
    rejected_patches: Optional["capo_ssm.types.patch_id_list.PatchIdList"] = None,
    rejected_patches_action: Optional[
        "capo_ssm.types.patch_action.PatchAction"
    ] = None,
    description: Optional[
        "capo_ssm.types.baseline_description.BaselineDescription"
    ] = None,
    sources: Optional["capo_ssm.types.patch_source_list.PatchSourceList"] = None,
    available_security_updates_compliance_status: Optional[
        "capo_ssm.types.patch_compliance_status.PatchComplianceStatus"
    ] = None,
    client_token: Optional["capo_ssm.types.client_token.ClientToken"] = None,
    tags: Optional["capo_ssm.types.tag_list.TagList"] = None,
) -> "capo_ssm.types.create_patch_baseline_result.CreatePatchBaselineResult":
    """<p>Creates a patch baseline.</p> <note> <p>For information about valid key-value pairs in <code>PatchFilters</code> for each supported operating system type, see <a>PatchFilter</a>.</p> </note>

    Args:
        operating_system: <p>Defines the operating system the patch baseline applies to. The default value is <code>WINDOWS</code>.</p>
        name: <p>The name of the patch baseline.</p>
        global_filters: <p>A set of global filters used to include patches in the baseline.</p> <important> <p>The <code>GlobalFilters</code> parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager console, and its value isn't displayed in the console.</p> </important>
        approval_rules: <p>A set of rules used to include patches in the baseline.</p>
        approved_patches: <p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
        approved_patches_compliance_level: <p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is <code>UNSPECIFIED</code>.</p>
        approved_patches_enable_non_security: <p>Indicates whether the list of approved patches includes non-security updates that should be applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed nodes only.</p>
        rejected_patches: <p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html">Package name formats for approved and rejected patch lists</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
        rejected_patches_action: <p>The action for Patch Manager to take on patches included in the <code>RejectedPackages</code> list.</p> <dl> <dt>ALLOW_AS_DEPENDENCY</dt> <dd> <p> <b>Linux and macOS</b>: A package in the rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as <code>INSTALLED_OTHER</code>. This is the default action if no option is specified.</p> <p> <b>Windows Server</b>: Windows Server doesn't support the concept of package dependencies. If a package in the rejected patches list and already installed on the node, its status is reported as <code>INSTALLED_OTHER</code>. Any package not already installed on the node is skipped. This is the default action if no option is specified.</p> </dd> <dt>BLOCK</dt> <dd> <p> <b>All OSs</b>: Packages in the rejected patches list, and packages that include them as dependencies, aren't installed by Patch Manager under any circumstances. </p> <p>State value assignment for patch compliance:</p> <ul> <li> <p>If a package was installed before it was added to the rejected patches list, or is installed outside of Patch Manager afterward, it's considered noncompliant with the patch baseline and its status is reported as <code>INSTALLED_REJECTED</code>.</p> </li> <li> <p>If an update attempts to install a dependency package that is now rejected by the baseline, when previous versions of the package were not rejected, the package being updated is reported as <code>MISSING</code> for <code>SCAN</code> operations and as <code>FAILED</code> for <code>INSTALL</code> operations.</p> </li> </ul> </dd> </dl>
        description: <p>A description of the patch baseline.</p>
        sources: <p>Information about the patches to use to update the managed nodes, including target operating systems and source repositories. Applies to Linux managed nodes only.</p>
        available_security_updates_compliance_status: <p>Indicates the status you want to assign to security patches that are available but not approved because they don't meet the installation criteria specified in the patch baseline.</p> <p>Example scenario: Security patches that you might want installed can be skipped if you have specified a long period to wait after a patch is released before installation. If an update to the patch is released during your specified waiting period, the waiting period for installing the patch starts over. If the waiting period is too long, multiple versions of the patch could be released but never installed.</p> <p>Supported for Windows Server managed nodes only.</p>
        client_token: <p>User-provided idempotency token.</p>
        tags: <p>Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=PatchSeverity,Value=Critical</code> </p> </li> <li> <p> <code>Key=OS,Value=Windows</code> </p> </li> </ul> <note> <p>To add tags to an existing patch baseline, use the <a>AddTagsToResource</a> operation.</p> </note>

    Raises:
        capo_ssm.errors.idempotent_parameter_mismatch.IdempotentParameterMismatch: <p>Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token. </p>
        capo_ssm.errors.internal_server_error.InternalServerError: <p>An error occurred on the server side.</p>
        capo_ssm.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>Error returned when the caller has exceeded the default resource quotas. For example, too many maintenance windows or patch baselines have been created.</p> <p>For information about resource quotas in Systems Manager, see <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm">Systems Manager service quotas</a> in the <i>Amazon Web Services General Reference</i>.</p>
        capo_ssm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm.types.create_patch_baseline_request.CreatePatchBaselineRequest]",
    ) -> AsyncOperationResponse[
        "capo_ssm.types.create_patch_baseline_result.CreatePatchBaselineResult"
    ]:
        import capo_ssm._operations.amazon_ssm.create_patch_baseline

        (
            output,
            http_response,
        ) = await capo_ssm._operations.amazon_ssm.create_patch_baseline.async_create_patch_baseline(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ssm.types.create_patch_baseline_request.CreatePatchBaselineRequest",
    ) -> dict[str, Any]:
        import capo_ssm.types.create_patch_baseline_request

        return capo_ssm.types.create_patch_baseline_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreatePatchBaseline", redact_input=_redact_input),
    )
    input_: capo_ssm.types.create_patch_baseline_request.CreatePatchBaselineRequest = {
        "name": name
    }
    if operating_system is not None:
        input_["operating_system"] = operating_system
    if global_filters is not None:
        input_["global_filters"] = global_filters
    if approval_rules is not None:
        input_["approval_rules"] = approval_rules
    if approved_patches is not None:
        input_["approved_patches"] = approved_patches
    if approved_patches_compliance_level is not None:
        input_["approved_patches_compliance_level"] = (
            approved_patches_compliance_level
        )
    if approved_patches_enable_non_security is not None:
        input_["approved_patches_enable_non_security"] = (
            approved_patches_enable_non_security
        )
    if rejected_patches is not None:
        input_["rejected_patches"] = rejected_patches
    if rejected_patches_action is not None:
        input_["rejected_patches_action"] = rejected_patches_action
    if description is not None:
        input_["description"] = description
    if sources is not None:
        input_["sources"] = sources
    if available_security_updates_compliance_status is not None:
        input_["available_security_updates_compliance_status"] = (
            available_security_updates_compliance_status
        )
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output