update_ip_access_settings ¶

def update_ip_access_settings(
    self,
    ip_access_settings_arn: "capo_workspaces_web.types.arn.ARN",
    *,
    config_overrides: Optional[WorkSpacesWebClientConfig] = None,
    display_name: Optional[
        "capo_workspaces_web.types.display_name.DisplayName"
    ] = None,
    description: Optional[
        "capo_workspaces_web.types.description.Description"
    ] = None,
    ip_rules: Optional["capo_workspaces_web.types.ip_rule_list.IpRuleList"] = None,
    client_token: Optional[
        "capo_workspaces_web.types.client_token.ClientToken"
    ] = None,
) -> "capo_workspaces_web.types.update_ip_access_settings_response.UpdateIpAccessSettingsResponse":
    """<p>Updates IP access settings.</p>

    Args:
        ip_access_settings_arn: <p>The ARN of the IP access settings.</p>
        display_name: <p>The display name of the IP access settings.</p>
        description: <p>The description of the IP access settings.</p>
        ip_rules: <p>The updated IP rules of the IP access settings.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>

    Raises:
        capo_workspaces_web.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_workspaces_web.errors.internal_server_exception.InternalServerException: <p>There is an internal server error.</p>
        capo_workspaces_web.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource cannot be found.</p>
        capo_workspaces_web.errors.throttling_exception.ThrottlingException: <p>There is a throttling error.</p>
        capo_workspaces_web.errors.validation_exception.ValidationException: <p>There is a validation error.</p>
        capo_workspaces_web.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces_web.types.update_ip_access_settings_request.UpdateIpAccessSettingsRequest]",
    ) -> OperationResponse[
        "capo_workspaces_web.types.update_ip_access_settings_response.UpdateIpAccessSettingsResponse"
    ]:
        import capo_workspaces_web._operations.aws_ermine_control_plane_service.update_ip_access_settings

        output, http_response = (
            capo_workspaces_web._operations.aws_ermine_control_plane_service.update_ip_access_settings.update_ip_access_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workspaces_web.types.update_ip_access_settings_request.UpdateIpAccessSettingsRequest",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.update_ip_access_settings_request

        return capo_workspaces_web.types.update_ip_access_settings_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_workspaces_web.types.update_ip_access_settings_response.UpdateIpAccessSettingsResponse",
    ) -> dict[str, Any]:
        import capo_workspaces_web.types.update_ip_access_settings_response

        return capo_workspaces_web.types.update_ip_access_settings_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateIpAccessSettings",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_workspaces_web.types.update_ip_access_settings_request.UpdateIpAccessSettingsRequest = {
        "ip_access_settings_arn": ip_access_settings_arn
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if description is not None:
        input_["description"] = description
    if ip_rules is not None:
        input_["ip_rules"] = ip_rules
    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