update_scope ¶

def update_scope(
    self,
    scope_identifier: "capo_network_security_manager.types.scope_identifier.ScopeIdentifier",
    update_token: "capo_network_security_manager.types.update_token.UpdateToken",
    is_published: "capo_network_security_manager.types.is_published.IsPublished",
    *,
    config_overrides: Optional[NetworkSecurityManagerClientConfig] = None,
    scope_description: Optional[
        "capo_network_security_manager.types.description.Description"
    ] = None,
    scope_configuration: Optional[
        "capo_network_security_manager.types.scope_configuration.ScopeConfiguration"
    ] = None,
    client_token: Optional[
        "capo_network_security_manager.types.idempotency_token.IdempotencyToken"
    ] = None,
) -> "capo_network_security_manager.types.update_scope_output.UpdateScopeOutput":
    """<p>Updates the specified scope. To prevent conflicting concurrent updates, provide the current <code>updateToken</code>. Use <code>isPublished</code> to publish the update or keep the scope as a draft.</p>

    Args:
        scope_identifier: <p>The identifier of the scope. This is the scope's Amazon Resource Name (ARN).</p>
        update_token: <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
        scope_description: <p>A description of the scope.</p>
        scope_configuration: <p>The configuration that defines which accounts and resources are in scope. If you don't include this member, the scope keeps its existing configuration.</p> <p>A new configuration can change which accounts and resources are selected, but it can't add or remove the account filter itself: a scope created for multi-account use stays multi-account, and a scope created for single-account use stays single-account.</p>
        is_published: <p>Specifies whether to publish the resource. When <code>true</code>, the resource is saved in published (<code>ACTIVE</code>) state. When <code>false</code>, it is saved as a draft (<code>DRAFT</code>).</p>
        client_token: <p>A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.</p>

    Raises:
        capo_network_security_manager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_network_security_manager.errors.conflict_exception.ConflictException: <p>The request conflicts with the current state of the resource. For example, the resource was modified concurrently, or it is in a state that does not allow the requested operation.</p>
        capo_network_security_manager.errors.internal_server_exception.InternalServerException: <p>The request processing failed because of an internal error in the service. This is a retryable error.</p>
        capo_network_security_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.</p>
        capo_network_security_manager.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would exceed a service quota.</p>
        capo_network_security_manager.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Reduce your request rate and try again.</p>
        capo_network_security_manager.errors.validation_exception.ValidationException: <p>The request failed validation. For details, see the <code>reason</code> and <code>fieldList</code> members of the response.</p>
        capo_network_security_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Update a scope and publish it
        Updates the scope's description and configuration and publishes the change. The updateToken from the most recent read is required for optimistic locking.

        >>> client.update_scope(scope_identifier='arn:aws:network-security-manager:us-east-1:123456789012:scope:abc123', update_token='b0c4d1e2-3f4a-4b5c-8d6e-7f8a9b0c1d2e', scope_description='Scope covering all production web application resources in US East 1', scope_configuration={'accountFilter': {'includeAll': {}}, 'resourceScopes': {}}, is_published=True)
    """

    def _handler(
        req: "OperationRequest[capo_network_security_manager.types.update_scope_input.UpdateScopeInput]",
    ) -> OperationResponse[
        "capo_network_security_manager.types.update_scope_output.UpdateScopeOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.update_scope

        output, http_response = (
            capo_network_security_manager._operations.piccolo_customer_api_service.update_scope.update_scope(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateScope")
    )
    input_: capo_network_security_manager.types.update_scope_input.UpdateScopeInput = {
        "scope_identifier": scope_identifier,
        "update_token": update_token,
        "is_published": is_published,
    }
    if scope_description is not None:
        input_["scope_description"] = scope_description
    if scope_configuration is not None:
        input_["scope_configuration"] = scope_configuration
    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